Markdown使用說(shuō)明

公司新增的產(chǎn)品中用Markdown來(lái)編寫產(chǎn)品更新日志,怎么在團(tuán)隊(duì)中介紹和推廣Markdown的使用落到我身上听皿。就簡(jiǎn)單地寫了一點(diǎn)沪斟,順便也在簡(jiǎn)書上復(fù)制一份吧。

認(rèn)識(shí)Markdown

Markdown是一種可以使用普通文本編輯器編寫的標(biāo)記語(yǔ)言查邢,通過(guò)簡(jiǎn)單的標(biāo)記語(yǔ)法,它可以使普通文本內(nèi)容具有一定的格式酵幕。Markdown的理念是扰藕,能讓文檔更容易讀、寫和隨意改芳撒。

使用Markdown來(lái)寫作自己的文稿邓深,可以節(jié)省大量的時(shí)間未桥,不需要耗費(fèi)精力在調(diào)整格式標(biāo)簽上。而且Markdown的語(yǔ)法也十分簡(jiǎn)單芥备。常用的標(biāo)記符號(hào)也不超過(guò)十個(gè)冬耿,學(xué)習(xí)成本不需要太多。下文會(huì)會(huì)結(jié)合我們的具體使用場(chǎng)景萌壳,介紹Markdown的主要語(yǔ)法亦镶。

Markdown常用語(yǔ)法介紹

標(biāo)題

在 Markdown中,如果一段文字被定義為標(biāo)題袱瓮,只要在這段文字前加#號(hào)即可缤骨。Markdown總共有六級(jí)標(biāo)題,使用方式為在編輯器中輸入#鍵尺借,在#號(hào)后加一個(gè)字符的空格绊起,然后輸入標(biāo)題名稱即可;如果是二級(jí)標(biāo)題就需要輸入兩個(gè)#褐望,依次類推勒庄。注意#和文字之間需要保留一個(gè)空格的字符,否則顯示會(huì)有問題瘫里。例如:

# 一級(jí)標(biāo)題
## 二級(jí)標(biāo)題
### 三級(jí)標(biāo)題
#### 四級(jí)標(biāo)題
###### 五級(jí)標(biāo)題
###### 六級(jí)標(biāo)題

具體效果如下:

一級(jí)標(biāo)題

二級(jí)標(biāo)題

三級(jí)標(biāo)題

四級(jí)標(biāo)題

五級(jí)標(biāo)題
六級(jí)標(biāo)題

粗體

Markdown 的粗體非常簡(jiǎn)單实蔽,用兩個(gè)*包含一段文本就是粗體的語(yǔ)法。 例如:

**這里是粗體語(yǔ)法**

具體效果如下:

這里是粗體語(yǔ)法

斜體

Markdown 的斜體的使用方式也非常簡(jiǎn)單谨读,用一個(gè) *包含一段文本就是斜體的語(yǔ)法局装。例如:

*這里是斜體語(yǔ)法*

具體效果如下:

這里是斜體語(yǔ)法

引用

如果你需要引用一小段別處的句子,那么就要用引用的格式劳殖,只需要在段落前加一個(gè)>就可以了铐尚。例如:

> 這里是引用的語(yǔ)法

具體效果如下:

這里是引用的語(yǔ)法

無(wú)序列表

列表的顯示只需要在文字前加上 -或 *即可變?yōu)闊o(wú)序列表。 例如:

- 無(wú)序列表1 
- 無(wú)序列表2
- 無(wú)序列表3

具體效果如下:

  • 無(wú)序列表1
  • 無(wú)序列表2
  • 無(wú)序列表3

有序列表

有序列表直接在文字前加 1. 2. 3.就可以了哆姻。 例如:

1. 有序列表1
2. 有序列表2
3. 有序列表3

具體效果如下:

  1. 有序列表1
  2. 有序列表2
  3. 有序列表3

鏈接

插入鏈接的語(yǔ)法是[顯示文本](鏈接地址)宣增。例如:

[知乎](https://www.zhihu.com/)

具體效果如下:

知乎

圖片

插入圖片與插入鏈接的語(yǔ)法很像,語(yǔ)法為![](圖片鏈接地址)矛缨,只是多了一個(gè)感嘆號(hào)爹脾,其中感嘆號(hào)是英文的,[方括號(hào)]標(biāo)記圖片的替代文字箕昭,[方括號(hào)]內(nèi)可以不寫文字灵妨,但[方括號(hào)]一定要帶著,相當(dāng)于圖片的alt描述落竹。例如:

![王子](http://note.youdao.com/yws/public/resource/118d9f64ac08c5f323820756ef7d19ce/xmlnote/16571CBE3D034D419772CE255FE3294C/959g)

具體效果如下:


王子

表格

表格的語(yǔ)法相對(duì)復(fù)雜一點(diǎn)泌霍,不過(guò)使用習(xí)慣就好了,關(guān)鍵是理解語(yǔ)法的含義述召,語(yǔ)法如下朱转。例如:

| 一個(gè)普通標(biāo)題 | 一個(gè)普通標(biāo)題 | 一個(gè)普通標(biāo)題 |
| ------ | ------ | ------ |
| 短文本 | 中等文本 | 稍微長(zhǎng)一點(diǎn)的文本 |
| 稍微長(zhǎng)一點(diǎn)的文本 | 短文本 | 中等文本 |

注意我們?cè)谑褂玫臅r(shí)候不需要保證 | 非得要對(duì)齊蟹地,多余的空格會(huì)被自動(dòng)忽略掉。不然有強(qiáng)迫癥的同學(xué)肯定會(huì)瘋掉藤为。

具體效果如下:

普通標(biāo)題 普通標(biāo)題 普通標(biāo)題
短文本 中等文本 稍微長(zhǎng)一點(diǎn)的文本
稍微長(zhǎng)一點(diǎn)的文本 短文本 中等文本

如果需要設(shè)置對(duì)齊锈津,需要下面的格式來(lái)書寫。語(yǔ)法說(shuō)明如下:

  1. |凉蜂、-、:之間的多余空格會(huì)被忽略性誉,不影響布局窿吩。

  2. 默認(rèn)標(biāo)題欄居中對(duì)齊,內(nèi)容居左對(duì)齊错览。

  3. -:表示內(nèi)容和標(biāo)題欄居右對(duì)齊纫雁,:-表示內(nèi)容和標(biāo)題欄居左對(duì)齊,:-:表示內(nèi)容和標(biāo)題欄居中對(duì)齊倾哺。

  4. 內(nèi)容和|之間的多余空格會(huì)被忽略轧邪,每行第一個(gè)|和最后一個(gè)|可以省略,-的數(shù)量至少有一個(gè)羞海。

| 左對(duì)齊標(biāo)題 | 右對(duì)齊標(biāo)題 | 居中對(duì)齊標(biāo)題 |
| :------| ------: | :------: |
| 短文本 | 中等文本 | 稍微長(zhǎng)一點(diǎn)的文本 |
| 稍微長(zhǎng)一點(diǎn)的文本 | 短文本 | 中等文本 |

具體效果如下:

左對(duì)齊標(biāo)題 右對(duì)齊標(biāo)題 居中對(duì)齊標(biāo)題
短文本 中等文本 稍微長(zhǎng)一點(diǎn)的文本
稍微長(zhǎng)一點(diǎn)的文本 短文本 中等文本

代碼引用

需要引用代碼時(shí)忌愚,如果引用的語(yǔ)句只有一段,不分行却邓,可以用 ` 將語(yǔ)句前后包起來(lái)硕糊。

具體效果如下:

Hello Word

如果引用的語(yǔ)句為多行,可以將```置于這段代碼的首行和末行腊徙。

具體效果如下:

<!DOCTYPE html>
<html>
<body>

<?php
$cars=array("Volvo","BMW","HAVAL"); 
echo "I like " . $cars[0] . "简十," . $cars[1] . " and " . $cars[2] . ".";
?>

</body>
</html>

分隔線

分隔線的使用很簡(jiǎn)單,用---或者***就可以了撬腾。例如:

---

具體效果如下:


全屏模式

當(dāng)你對(duì)Markdown的基本語(yǔ)法已經(jīng)比較熟悉的時(shí)候螟蝙,你就可以使用在全屏模式下編寫文本,這樣可以大大提高你的文本編寫速度民傻。

常見問題

換行問題

不同的編輯器中Markdown展現(xiàn)的效果不完全一致胰默,同時(shí)部分廠商也有自己的語(yǔ)法,比如有的編輯器就支持待辦事宜Todo列表和流程圖等饰潜。

我們只要掌握最常見的語(yǔ)法初坠,也就是上文提及的就完全可以應(yīng)對(duì)絕大多數(shù)使用場(chǎng)景。

換行問題

Markdown對(duì)換行的語(yǔ)法規(guī)范是空格+空格+回車換行彭雾,也就是說(shuō)碟刺,如果你要進(jìn)行換行操作,你需要先按兩次空格鍵薯酝,然后按一次回車鍵即可半沽。

分段落問題

Markdown對(duì)分段的語(yǔ)法規(guī)范是按兩次回車鍵爽柒,也就是說(shuō),如果你要進(jìn)行分段操作者填,你只需要按兩次回車鍵即可浩村。當(dāng)然,多次使用回車鍵的效果與按兩次回車鍵的效果一樣占哟,并不會(huì)產(chǎn)生多余的空白行心墅。

我們可以看到分段帶來(lái)的間距要大于換行帶來(lái)的間距,使用的時(shí)候要注意榨乎。

標(biāo)簽規(guī)范使用問題

規(guī)范的Markdown語(yǔ)法是怎燥,使用的標(biāo)簽和后面的文本要有一個(gè)字符的空格,否則可能在后臺(tái)預(yù)覽正常蜜暑,但是前臺(tái)卻不會(huì)正常顯示铐姚。

總結(jié)

熟悉以上這些Markdown的語(yǔ)法后,在日常使用中基本就沒什么大問題了肛捍,只要多加練習(xí)使用起來(lái)就可以很快體會(huì)到Markdown的簡(jiǎn)潔和易用隐绵,效率也自然提升。

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末拙毫,一起剝皮案震驚了整個(gè)濱河市依许,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌恬偷,老刑警劉巖悍手,帶你破解...
    沈念sama閱讀 221,548評(píng)論 6 515
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場(chǎng)離奇詭異袍患,居然都是意外死亡坦康,警方通過(guò)查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 94,497評(píng)論 3 399
  • 文/潘曉璐 我一進(jìn)店門诡延,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái)滞欠,“玉大人,你說(shuō)我怎么就攤上這事肆良∩歌担” “怎么了?”我有些...
    開封第一講書人閱讀 167,990評(píng)論 0 360
  • 文/不壞的土叔 我叫張陵惹恃,是天一觀的道長(zhǎng)夭谤。 經(jīng)常有香客問我,道長(zhǎng)巫糙,這世上最難降的妖魔是什么朗儒? 我笑而不...
    開封第一講書人閱讀 59,618評(píng)論 1 296
  • 正文 為了忘掉前任,我火速辦了婚禮,結(jié)果婚禮上醉锄,老公的妹妹穿的比我還像新娘乏悄。我一直安慰自己,他們只是感情好恳不,可當(dāng)我...
    茶點(diǎn)故事閱讀 68,618評(píng)論 6 397
  • 文/花漫 我一把揭開白布檩小。 她就那樣靜靜地躺著,像睡著了一般烟勋。 火紅的嫁衣襯著肌膚如雪规求。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 52,246評(píng)論 1 308
  • 那天卵惦,我揣著相機(jī)與錄音颓哮,去河邊找鬼。 笑死鸵荠,一個(gè)胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的伤极。 我是一名探鬼主播蛹找,決...
    沈念sama閱讀 40,819評(píng)論 3 421
  • 文/蒼蘭香墨 我猛地睜開眼,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼哨坪!你這毒婦竟也來(lái)了庸疾?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 39,725評(píng)論 0 276
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤团赁,失蹤者是張志新(化名)和其女友劉穎栗柒,沒想到半個(gè)月后孔庭,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 46,268評(píng)論 1 320
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡金顿,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 38,356評(píng)論 3 340
  • 正文 我和宋清朗相戀三年,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了鲤桥。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片揍拆。...
    茶點(diǎn)故事閱讀 40,488評(píng)論 1 352
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡,死狀恐怖茶凳,靈堂內(nèi)的尸體忽然破棺而出嫂拴,到底是詐尸還是另有隱情,我是刑警寧澤贮喧,帶...
    沈念sama閱讀 36,181評(píng)論 5 350
  • 正文 年R本政府宣布筒狠,位于F島的核電站,受9級(jí)特大地震影響箱沦,放射性物質(zhì)發(fā)生泄漏辩恼。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,862評(píng)論 3 333
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望运挫。 院中可真熱鬧状共,春花似錦、人聲如沸谁帕。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,331評(píng)論 0 24
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)匈挖。三九已至碾牌,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間儡循,已是汗流浹背舶吗。 一陣腳步聲響...
    開封第一講書人閱讀 33,445評(píng)論 1 272
  • 我被黑心中介騙來(lái)泰國(guó)打工, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留择膝,地道東北人誓琼。 一個(gè)月前我還...
    沈念sama閱讀 48,897評(píng)論 3 376
  • 正文 我出身青樓,卻偏偏與公主長(zhǎng)得像肴捉,于是被迫代替她去往敵國(guó)和親腹侣。 傳聞我的和親對(duì)象是個(gè)殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 45,500評(píng)論 2 359

推薦閱讀更多精彩內(nèi)容

  • 認(rèn)識(shí)Markdown Markdown的理念是齿穗,能讓文檔更容易讀傲隶、寫和隨意改。使用其他常見的富文本編輯器窃页,您可能需...
    刑素素閱讀 1,299評(píng)論 0 0
  • markdown -- 易讀易寫 Foo this is an H1 this is an H2 ps. = 表...
    Eric蘇離閱讀 380評(píng)論 0 1
  • 為什么學(xué)習(xí)Markdown 自從搭建了 Hexo 博客之后跺株,發(fā)現(xiàn)還有 Markdown 這種寫文章的方法,想到以后...
    lifeColder閱讀 20,164評(píng)論 10 216
  • Markdown 語(yǔ)法說(shuō)明 概述宗旨兼容HTML 區(qū)塊元素段落和換行標(biāo)題區(qū)塊引用列表代碼區(qū)塊表格分割線刪除線 區(qū)段...
    咚呱閱讀 935評(píng)論 1 2
  • 平凡如我脖卖,卻也不甘過(guò)一眼望得到盡頭的人生乒省。對(duì)未來(lái)抱有期待,該是對(duì)生活最起碼的尊重畦木。 九月作儿,清晨,湛...
    lucky雪晴閱讀 315評(píng)論 0 0