MarkDown簡明指南(完美適配簡書)

一、概覽

1.1 MarkDown宗旨

目標(biāo)是實現(xiàn)「易讀易寫」,使用特殊的文本標(biāo)記達到內(nèi)容表達的簡潔性和一致性。

1.2 最常用MarkDown標(biāo)記

# 一級標(biāo)題
## 二級標(biāo)題
### 三級標(biāo)題
###### 六級標(biāo)題

* 無序列表第一項
* 無序列表第二項
* 無序列表第三項

1. 有序列表第一項
2. 有序列表第二項
3. 有序列表第二項

表格第一格表頭 | 表格第二格表頭
--------- | -------------
內(nèi)容單元格 第一列第一格 | 內(nèi)容單元格第二列第一格
內(nèi)容單元格 第一列第二格 多加文字 | 內(nèi)容單元格第二列第二格

> 引用段落

` ` `
代碼塊
` ` `

*斜體*
**粗體**
~~刪除~~
文字行內(nèi)` 引用 `
文字行內(nèi)`` 引用 ``

---  分割線

[標(biāo)題](鏈接地址)

![圖片描述](圖片鏈接地址)

以上為最常用的標(biāo)簽,已經(jīng)可以滿足基本的書寫要求毅弧。
如果要了解更多細(xì)節(jié)卧惜,繼續(xù)瀏覽剩余章節(jié)澜沟。

1.3 本文書寫方式說明

1.3.1. 文中黑色方框的地方,都用code標(biāo)記 ``` ... ...```包圍贞奋,其中為Markdown代碼超全。
1.3.2. 緊接著顯示的內(nèi)容為上面Markdown代碼的實際效果咆霜。
1.3.3. 一段“Markdown代碼+實際顯示效果”用上下兩條分割線分隔。
1.3.4. 本文中的“Markdown代碼”在簡書平臺的編輯器測試通過嘶朱。

二蛾坯、區(qū)塊元素

2.1 段落和換行

一個 Markdown 段落是由一個或多個連續(xù)的文本行組成,它的前后要有一個以上的空行疏遏。普通段落不該用空格或制表符來縮進脉课。

2.2 標(biāo)題 H1...H6


在行首插入 1 到 6 個 # 救军,對應(yīng)到標(biāo)題 1 到 6 階,例如:

# 這是 H1

## 這是 H2

###### 這是 H6

這是 H1

這是 H2

這是 H6

2.3 區(qū)塊引用 Blockquotes


在每行的最前面加上 > 倘零,也允許只在整個段落的第一行最前面加上 > :

> This is a blockquote with two paragraphs. Lorem ipsum dolor sit amet,
> consectetuer adipiscing elit. Aliquam hendrerit mi posuere lectus.
> 
> Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse
> id sem consectetuer libero luctus adipiscing.

This is a blockquote with two paragraphs. Lorem ipsum dolor sit amet,
consectetuer adipiscing elit. Aliquam hendrerit mi posuere lectus.

Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse
id sem consectetuer libero luctus adipiscing.


區(qū)塊引用可以嵌套唱遭,也可以使用其他的 Markdown 語法,包括標(biāo)題呈驶、列表拷泽、代碼區(qū)塊等:

> ## 這是一個標(biāo)題。
>  
> 1.   這是第一行列表項袖瞻。
> 2.   這是第二行列表項司致。
>
> 引用嵌套
> > This is nested blockquote.
>
> 給出一些例子代碼:
> 
>     return shell_exec("echo $input | $markdown_script");

這是一個標(biāo)題。

  1. 這是第一行列表項聋迎。
  2. 這是第二行列表項脂矫。

引用嵌套

This is nested blockquote.

給出一些例子代碼:

return shell_exec("echo $input | $markdown_script");

2.4 列表

Markdown 支持有序列表和無序列表。


無序列表使用星號(*)霉晕、加號(+)或是減號(-)作為列表標(biāo)記:

*   Red
*   Green
*   Blue
+   Red
+   Green
+   Blue
-   Red
-   Green
-   Blue
  • Red
  • Green
  • Blue

有序列表則使用數(shù)字接著一個英文句點:

1.  Bird
2.  McHale
3.  Parish
  1. Bird
  2. McHale
  3. Parish

列表項目可以包含多個段落庭再,每個項目下的段落都必須縮進 4 個空格或是 1 個制表符:

1.  This is a list item with two paragraphs. Lorem ipsum dolor
    sit amet, consectetuer adipiscing elit. Aliquam hendrerit
    mi posuere lectus.

    Vestibulum enim wisi, viverra nec, fringilla in, laoreet
    vitae, risus. Donec sit amet nisl. Aliquam semper ipsum
    sit amet velit.

2.  Suspendisse id sem consectetuer libero luctus adipiscing.
  1. This is a list item with two paragraphs. Lorem ipsum dolor
    sit amet, consectetuer adipiscing elit. Aliquam hendrerit
    mi posuere lectus.

    Vestibulum enim wisi, viverra nec, fringilla in, laoreet
    vitae, risus. Donec sit amet nisl. Aliquam semper ipsum
    sit amet velit.

  2. Suspendisse id sem consectetuer libero luctus adipiscing.


如果要在列表項目內(nèi)放進引用,那 > 就需要縮進:

*   A list item with a blockquote:

    > This is a blockquote
    > inside a list item.

如果要放代碼區(qū)塊的話牺堰,該區(qū)塊就需要縮進兩次拄轻,也就是 8 個空格或是 2 個制表符:

*   一列表項包含一個列表區(qū)塊:

        <代碼寫在這>
  • 一列表項包含一個列表區(qū)塊:

    <代碼寫在這> 
    

2.5 表格

表格用來組織結(jié)構(gòu)化的內(nèi)容

第一格表頭 | 第二格表頭
--------- | -------------
內(nèi)容單元格 第一列第一格 | 內(nèi)容單元格第二列第一格
內(nèi)容單元格 第一列第二格 多加文字 | 內(nèi)容單元格第二列第二格
第一格表頭 第二格表頭
內(nèi)容單元格 第一列第一格 內(nèi)容單元格第二列第一格
內(nèi)容單元格 第一列第二格 多加文字 內(nèi)容單元格第二列第二格

2.6 代碼區(qū)塊

建立代碼區(qū)塊有兩種方式:

  1. 隱式聲明: 縮進 4 個空格或是 1 個制表符
  2. 顯式聲明:使用連續(xù)3個鍵盤上第二行第一個鍵進行包圍,``` ... ... ```

兩種方式效果都是一樣的萌焰,簡單的隱式聲明例如:

這是一個普通段落:

    print('Hello World!')

這是一個普通段落:

print('Hello World!')

2.7 分隔線

你可以在一行中用三個以上的星號哺眯、減號谷浅、底線來建立一個分隔線扒俯,行內(nèi)不能有其他東西。你也可以在星號或是減號中間插入空格一疯。下面每種寫法都可以建立分隔線:

* * *

***

*****

- - -

---------------------------------------

三撼玄、 區(qū)段元素

3.1 鏈接

Markdown 支持兩種形式的鏈接語法: 行內(nèi)式和參考式兩種形式。

不管是哪一種墩邀,鏈接文字都是用 [方括號] 來標(biāo)記掌猛。


要建立一個行內(nèi)式的鏈接,只要在方塊括號后面緊接著圓括號并插入網(wǎng)址鏈接即可眉睹,如果你還想要加上鏈接的 title 文字荔茬,只要在網(wǎng)址后面,用雙引號把 title 文字包起來即可竹海,例如:

This is [an example](http://example.com/ "Title") inline link.

[This link](http://example.net/) has no title attribute.

This is an example inline link.

This link has no title attribute.


參考式的鏈接是在鏈接文字的括號后面再接上另一個方括號慕蔚,而在第二個方括號里面要填入用以辨識鏈接的標(biāo)記:

This is [an example][id] reference-style link.

你也可以選擇性地在兩個方括號中間加上一個空格
接著,在文件的任意處斋配,你可以把這個標(biāo)記的鏈接內(nèi)容定義出來

[id]: http://example.com/  "Optional Title Here"

This is an example reference-style link.

你也可以選擇性地在兩個方括號中間加上一個空格
接著孔飒,在文件的任意處灌闺,你可以把這個標(biāo)記的鏈接內(nèi)容定義出來


網(wǎng)址定義只有在產(chǎn)生鏈接的時候用到,并不會直接出現(xiàn)在文件之中坏瞄。

鏈接辨別標(biāo)簽可以有字母桂对、數(shù)字、空白和標(biāo)點符號鸠匀,但不區(qū)分大小寫蕉斜,因此下面兩個鏈接是一樣的:

[link text][a]
[link text][A]

隱式鏈接標(biāo)記功能讓你可以省略指定鏈接標(biāo)記,這種情形下狮崩,鏈接標(biāo)記會視為等同于鏈接文字蛛勉,要用隱式鏈接標(biāo)記只要在鏈接文字后面加上一個空的方括號,如果你要讓 "Google" 鏈接到 google.com睦柴,你可以簡化成:

[Google][]
[Google]: http://google.com/

鏈接的定義可以放在文件中的任何一個地方诽凌,我比較偏好直接放在鏈接出現(xiàn)段落的后面,你也可以把它放在文件最后面坦敌,就像是注解一樣侣诵。

3.2 強調(diào)


Markdown 使用星號(*)和底線(_)作為標(biāo)記強調(diào)字詞的符號,
被 * 或 _ 包圍的字詞會被轉(zhuǎn)成用 <em> 標(biāo)簽包圍狱窘,
用兩個 * 或 _ 包起來的話杜顺,則會被轉(zhuǎn)成 <strong>,例如:

*single asterisks*

_single underscores_

**double asterisks**

__double underscores__

single asterisks

single underscores

double asterisks

double underscores


其實蘸炸,可以隨便用你喜歡的樣式躬络,唯一的限制是,你用什么符號開啟標(biāo)簽搭儒,就要用什么符號結(jié)束穷当。

3.3 代碼


如果要標(biāo)記一小段行內(nèi)代碼,你可以用反引號把它包起來(`)淹禾,例如:

Use the `printf()` function.

Use the printf() function.


如果要在代碼區(qū)段內(nèi)插入反引號馁菜,你可以用多個反引號來開啟和結(jié)束代碼區(qū)段:

``There is a literal backtick (`) here.``

There is a literal backtick (`) here.


代碼區(qū)段的起始和結(jié)束端都可以放入一個空白,起始端后面一個铃岔,結(jié)束端前面一個汪疮,這樣你就可以在區(qū)段的一開始就插入反引號:

A single backtick in a code span: `` ` ``

A backtick-delimited string in a code span: `` `foo` ``

A single backtick in a code span: `

A backtick-delimited string in a code span: `foo`


在代碼區(qū)段內(nèi),& 和方括號都會被自動地轉(zhuǎn)成 HTML 實體毁习,這使得插入 HTML 原始碼變得很容易智嚷,Markdown 會把下面這段:

Please don't use any `<blink>` tags.

Please don't use any <blink> tags.

3.4 圖片

很明顯地,要在純文字應(yīng)用中設(shè)計一個「自然」的語法來插入圖片是有一定難度的纺且。

Markdown 使用一種和鏈接很相似的語法來標(biāo)記圖片盏道,同樣也允許兩種樣式: 行內(nèi)式和參考式。

行內(nèi)式的圖片語法看起來像是:

![Alt text](/path/to/img.jpg)

![Alt text](/path/to/img.jpg "Optional title")

詳細(xì)敘述如下:

  • 一個驚嘆號 !
  • 接著一個方括號隆檀,里面放上圖片的替代文字
  • 接著一個普通括號摇天,里面放上圖片的網(wǎng)址粹湃,最后還可以用引號包住并加上 選擇性的 'title' 文字。

參考式的圖片語法則長得像這樣:

![Alt text][id]

「id」是圖片參考的名稱泉坐,圖片參考的定義方式則和連結(jié)參考一樣:

[id]: url/to/image  "Optional title attribute"

到目前為止为鳄, Markdown 還沒有辦法指定圖片的寬高,如果你需要的話腕让,你可以使用普通的 <img> 標(biāo)簽孤钦。

3.5 其它

反斜杠

Markdown 可以利用反斜杠來插入一些在語法中有其它意義的符號,例如:如果你想要用星號加在文字旁邊的方式來做出強調(diào)效果(但不用 <em> 標(biāo)簽)纯丸,你可以在星號的前面加上反斜杠:

\*literal asterisks\*

Markdown 支持以下這些符號前面加上反斜杠來幫助插入普通的符號:

\   反斜線
`   反引號
*   星號
_   底線
{}  花括號
[]  方括號
()  括弧
#   井字號
+   加號
-   減號
.   英文句點
!   驚嘆號

自動鏈接


Markdown 支持以比較簡短的自動鏈接形式來處理網(wǎng)址和電子郵件信箱偏形,只要是用尖括號包起來, Markdown 就會自動把它轉(zhuǎn)成鏈接觉鼻。一般網(wǎng)址的鏈接文字就和鏈接地址一樣俊扭,例如:

<http://example.com/>

http://example.com/


郵址的自動鏈接也很類似,例如:

<address@example.com>

address@example.com

四坠陈、感謝

感謝http://daringfireball.net/projects/markdown/

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末萨惑,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子仇矾,更是在濱河造成了極大的恐慌庸蔼,老刑警劉巖,帶你破解...
    沈念sama閱讀 211,042評論 6 490
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件贮匕,死亡現(xiàn)場離奇詭異姐仅,居然都是意外死亡,警方通過查閱死者的電腦和手機刻盐,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 89,996評論 2 384
  • 文/潘曉璐 我一進店門掏膏,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人隙疚,你說我怎么就攤上這事壤追】牡溃” “怎么了供屉?”我有些...
    開封第一講書人閱讀 156,674評論 0 345
  • 文/不壞的土叔 我叫張陵,是天一觀的道長溺蕉。 經(jīng)常有香客問我伶丐,道長,這世上最難降的妖魔是什么疯特? 我笑而不...
    開封第一講書人閱讀 56,340評論 1 283
  • 正文 為了忘掉前任哗魂,我火速辦了婚禮,結(jié)果婚禮上漓雅,老公的妹妹穿的比我還像新娘录别。我一直安慰自己朽色,他們只是感情好,可當(dāng)我...
    茶點故事閱讀 65,404評論 5 384
  • 文/花漫 我一把揭開白布组题。 她就那樣靜靜地躺著葫男,像睡著了一般。 火紅的嫁衣襯著肌膚如雪崔列。 梳的紋絲不亂的頭發(fā)上梢褐,一...
    開封第一講書人閱讀 49,749評論 1 289
  • 那天,我揣著相機與錄音赵讯,去河邊找鬼盈咳。 笑死,一個胖子當(dāng)著我的面吹牛边翼,可吹牛的內(nèi)容都是我干的鱼响。 我是一名探鬼主播,決...
    沈念sama閱讀 38,902評論 3 405
  • 文/蒼蘭香墨 我猛地睜開眼组底,長吁一口氣:“原來是場噩夢啊……” “哼热押!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起斤寇,我...
    開封第一講書人閱讀 37,662評論 0 266
  • 序言:老撾萬榮一對情侶失蹤桶癣,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后娘锁,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體牙寞,經(jīng)...
    沈念sama閱讀 44,110評論 1 303
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 36,451評論 2 325
  • 正文 我和宋清朗相戀三年莫秆,在試婚紗的時候發(fā)現(xiàn)自己被綠了间雀。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 38,577評論 1 340
  • 序言:一個原本活蹦亂跳的男人離奇死亡镊屎,死狀恐怖惹挟,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情缝驳,我是刑警寧澤连锯,帶...
    沈念sama閱讀 34,258評論 4 328
  • 正文 年R本政府宣布,位于F島的核電站用狱,受9級特大地震影響运怖,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜夏伊,卻給世界環(huán)境...
    茶點故事閱讀 39,848評論 3 312
  • 文/蒙蒙 一摇展、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧溺忧,春花似錦咏连、人聲如沸盯孙。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,726評論 0 21
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽镀梭。三九已至,卻和暖如春踱启,著一層夾襖步出監(jiān)牢的瞬間报账,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 31,952評論 1 264
  • 我被黑心中介騙來泰國打工埠偿, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留透罢,地道東北人。 一個月前我還...
    沈念sama閱讀 46,271評論 2 360
  • 正文 我出身青樓冠蒋,卻偏偏與公主長得像羽圃,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子抖剿,可洞房花燭夜當(dāng)晚...
    茶點故事閱讀 43,452評論 2 348

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