Markdown 文法說明 (簡體中文版)

<a target="_blank"></a>

markdown 的目标是實作「易讀易寫」。

總之， markdown 的文法全由一些符号所組成，這些符号經過精挑細選，其作用一目了然。比如：在文字兩旁加上星号，看起來就像*強調*。markdown 的清單看起來，嗯，就是清單。markdown 的區塊引用看起來就真的像是引用一段文字，就像你曾在電子郵件中見過的那樣。

markdown 文法的目标是：成為一種适用于網絡的書寫語言。

markdown 不是想要取代 html，甚至也沒有要和它相近，它的文法種類很少，隻對應 html 标記的一小部分。markdown 的構想不是要使得 html 文檔更容易書寫。在我看來， html 已經很容易寫了。markdown 的理念是，能讓文檔更容易讀、寫和随意改。html 是一種釋出的格式，markdown 是一種書寫的格式。就這樣，markdown 的格式文法隻涵蓋純文字可以涵蓋的範圍。

不在 markdown 涵蓋範圍之内的标簽，都可以直接在文檔裡面用 html 撰寫。不需要額外标注這是 html 或是 markdown；隻要直接加标簽就可以了。

要制約的隻有一些 html 區塊元素――比如 

、、

、

 等标簽，必須在前後加上空行與其它内容區隔開，還要求它們的開始标簽與結尾标簽不能用制表符或空格來縮進。markdown 的生成器有足夠智能，不會在 html 區塊标簽外加上不必要的 

标簽。

例子如下，在 markdown 檔案裡加上一段 html 表格：

foo

請注意，在 html 區塊标簽間的 markdown 格式文法将不會被處理。比如，你在 html 區塊内使用 markdown 樣式的*強調*會沒有效果。

html 的區段（行内）标簽如 、、 可以在 markdown 的段落、清單或是标題裡随意使用。依照個人習慣，甚至可以不用 markdown 格式，而直接采用 html 标簽來格式化。舉例說明：如果比較喜歡 html 的  或  标簽，可以直接使用這些标簽，而不用 markdown 提供的連結或是圖像标簽文法。

和處在 html 區塊标簽間不同，markdown 文法在 html 區段标簽間是有效的。

在 html 檔案中，有兩個字元需要特殊處理： &lt; 和 &amp; 。 &lt; 符号用于起始标簽，&amp; 符号則用于标記 html 實體，如果你隻是想要顯示這些字元的原型，你必須要使用實體的形式，像是 &lt; 和 &amp;。

&amp; 字元尤其讓網絡文檔編寫者受折磨，如果你要打「at&amp;t」 ，你必須要寫成「at&amp;t」。而網址中的 &amp; 字元也要轉換。比如你要連結到： http://images.google.com/images?num=30&amp;q=larry+bird

你必須要把網址轉換寫為： http://images.google.com/images?num=30&amp;q=larry+bird

才能放到連結标簽的 href 屬性裡。不用說也知道這很容易忽略，這也可能是 html 标準檢驗所檢查到的錯誤中，數量最多的。

markdown 讓你可以自然地書寫字元，需要轉換的由它來處理好了。如果你使用的 &amp; 字元是 html 字元實體的一部分，它會保留原狀，否則它會被轉換成 &amp;amp;。

是以你如果要在文檔中插入一個版權符号 ©，你可以這樣寫：©

markdown 會保留它不動。而若你寫：at&amp;t

markdown 就會将它轉為：at&amp;t

markdown 将會把它轉換為：4 &lt; 5

不過需要注意的是，code 範圍内，不論是行内還是區塊， &lt; 和 &amp; 兩個符号都一定會被轉換成 html 實體，這項特性讓你可以很容易地用 markdown 寫 html code （和 html 相對而言， html 文法中，你要把所有的 &lt; 和 &amp; 都轉換為 html 實體，才能在 html 檔案裡面寫出 html code。）

一個 markdown 段落是由一個或多個連續的文本行組成，它的前後要有一個以上的空行（空行的定義是顯示上看起來像是空的，便會被視為空行。比方說，若某一行隻包含空格和制表符，則該行也會被視為空行）。普通段落不該用空格或制表符來縮進。

「由一個或多個連續的文本行組成」這句話其實暗示了 markdown 允許段落内的強迫換行（插入換行符），這個特性和其他大部分的 text-to-html 格式不一樣（包括 movable type 的「convert line breaks」選項），其它的格式會把每個換行符都轉成 

 标簽。

如果你确實想要依賴 markdown 來插入 

 标簽的話，在插入處先按入兩個以上的空格然後回車。

的确，需要多費點事（多加空格）來産生 

 ，但是簡單地「每個換行都轉換為 

類 setext 形式是用底線的形式，利用 = （最高階标題）和 - （第二階标題），例如：

任何數量的 = 和 - 都可以有效果。

類 atx 形式則是在行首插入 1 到 6 個 # ，對應到标題 1 到 6 階，例如：

你可以選擇性地「閉合」類 atx 樣式的标題，這純粹隻是美觀用的，若是覺得這樣看起來比較舒适，你就可以在行尾加上 #，而行尾的# 數量也不用和開頭一樣（行首的井字元數量決定标題的階數）：

markdown 标記區塊引用是使用類似 email 中用 &gt; 的引用方式。如果你還熟悉在 email 信件中的引言部分，你就知道怎麼在 markdown 檔案中建立一個區塊引用，那會看起來像是你自己先斷好行，然後在每行的最前面加上 &gt; ：

markdown 也允許你偷懶隻在整個段落的第一行最前面加上 &gt; ：

區塊引用可以嵌套（例如：引用内的引用），隻要根據層次加上不同數量的 &gt; ：

引用的區塊内也可以使用其他的 markdown 文法，包括标題、清單、代碼區塊等：

任何像樣的文本編輯器都能輕松地建立 email 型的引用。例如在 bbedit 中，你可以選取文字後然後從選單中選擇增加引用階層。

markdown 支援有序清單和無序清單。

無序清單使用星号、加号或是減号作為清單标記：

等同于：

也等同于：

有序清單則使用數字接着一個英文句點：

很重要的一點是，你在清單标記上使用的數字并不會影響輸出的 html 結果，上面的清單所産生的 html 标記為：

bird

mchale

parish

如果你的清單标記寫成：

或甚至是：

你都會得到完全相同的 html 輸出。重點在于，你可以讓 markdown 檔案的清單數字和輸出的結果相同，或是你懶一點，你可以完全不用在意數字的正确性。

如果你使用懶惰的寫法，建議第一個項目最好還是從 1. 開始，因為 markdown 未來可能會支援有序清單的 start 屬性。

清單項目标記通常是放在最左邊，但是其實也可以縮進，最多 3 個空格，項目标記後面則一定要接着至少一個空格或制表符。

要讓清單看起來更漂亮，你可以把内容用固定的縮進整理好：

但是如果你懶，那也行：

如果清單項目間用空行分開，在輸出 html 時 markdown 就會将項目内容用 

 标簽包起來，舉例來說：

會被轉換為：

magic

但是這個：

清單項目可以包含多個段落，每個項目下的段落都必須縮進 4 個空格或是 1 個制表符：

如果你每行都有縮進，看起來會看好很多，當然，再次地，如果你很懶惰，markdown 也允許：

如果要在清單項目内放進引用，那 &gt; 就需要縮進：

如果要放代碼區塊的話，該區塊就需要縮進兩次，也就是 8 個空格或是 2 個制表符：

當然，項目清單很可能會不小心産生，像是下面這樣的寫法：

換句話說，也就是在行首出現數字-句點-空白，要避免這樣的狀況，你可以在句點前面加上反斜杠。

和程式相關的寫作或是标簽語言原始碼通常會有已經排版好的代碼區塊，通常這些區塊我們并不希望它以一般段落檔案的方式去排版，而是照原來的樣子顯示，markdown 會用 

 和  标簽來把代碼區塊包起來。

要在 markdown 中建立代碼區塊很簡單，隻要簡單地縮進 4 個空格或是 1 個制表符就可以，例如，下面的輸入：

markdown 會轉換成：

這是一個普通段落：

這個每行一階的縮進（4 個空格或是 1 個制表符），都會被移除，例如：

here is an example of applescript:

一個代碼區塊會一直持續到沒有縮進的那一行（或是檔案結尾）。

在代碼區塊裡面， &amp; 、 &lt; 和 &gt; 會自動轉成 html 實體，這樣的方式讓你非常容易使用 markdown 插入範例用的 html 原始碼，隻需要複制貼上，再加上縮進就可以了，剩下的 markdown 都會幫你處理，例如：

© 2004 foo corporation

代碼區塊中，一般的 markdown 文法不會被轉換，像是星号便隻是星号，這表示你可以很容易地以 markdown 文法撰寫 markdown 文法相關的檔案。

你可以在一行中用三個以上的星号、減号、底線來建立一個分隔線，行内不能有其他東西。你也可以在星号或是減号中間插入空格。下面每種寫法都可以建立分隔線：

markdown 支援兩種形式的連結文法： 行内式和參考式兩種形式。

不管是哪一種，連結文字都是用 [方括号] 來标記。

要建立一個行内式的連結，隻要在方塊括号後面緊接着圓括号并插入網址連結即可，如果你還想要加上連結的 title 文字，隻要在網址後面，用雙引号把 title 文字包起來即可，例如：

會産生：

如果你是要連結到同樣主機的資源，你可以使用相對路徑：

參考式的連結是在連結文字的括号後面再接上另一個方括号，而在第二個方括号裡面要填入用以辨識連結的标記：

你也可以選擇性地在兩個方括号中間加上一個空格：

接着，在檔案的任意處，你可以把這個标記的連結内容定義出來：

連結内容定義的形式為：

方括号（前面可以選擇性地加上至多三個空格來縮進），裡面輸傳入連結接文字

接着一個冒号

接着一個以上的空格或制表符

接着連結的網址

選擇性地接着 title 内容，可以用單引号、雙引号或是括弧包着

下面這三種連結的定義都是相同：

請注意：有一個已知的問題是 markdown.pl 1.0.1 會忽略單引号包起來的連結 title。

連結網址也可以用方括号包起來：

你也可以把 title 屬性放到下一行，也可以加一些縮進，若網址太長的話，這樣會比較好看：

網址定義隻有在産生連結的時候用到，并不會直接出現在檔案之中。

連結辨識标簽可以有字母、數字、空白和标點符号，但是并不區分大小寫，是以下面兩個連結是一樣的：

隐式連結标記功能讓你可以省略指定連結标記，這種情形下，連結标記會視為等同于連結文字，要用隐式連結标記隻要在連結文字後面加上一個空的方括号，如果你要讓 "google" 連結到 google.com，你可以簡化成：

然後定義連結内容：

由于連結文字可能包含空白，是以這種簡化型的标記内也許包含多個單詞：

然後接着定義連結：

連結的定義可以放在檔案中的任何一個地方，我比較偏好直接放在連結出現段落的後面，你也可以把它放在檔案最後面，就像是注解一樣。

下面是一個參考式連結的範例：

如果改成用連結名稱的方式寫：

上面兩種寫法都會産生下面的 html。

下面是用行内式寫的同樣一段内容的 markdown 檔案，提供作為比較之用：

參考式的連結其實重點不在于它比較好寫，而是它比較好讀，比較一下上面的範例，使用參考式的文章本身隻有 81 個字元，但是用行内形式的卻會增加到 176 個字元，如果是用純 html 格式來寫，會有 234 個字元，在 html 格式中，标簽比文本還要多。

使用 markdown 的參考式連結，可以讓檔案更像是浏覽器最後産生的結果，讓你可以把一些标記相關的中繼資料移到段落文字之外，你就可以增加連結而不讓文章的閱讀感覺被打斷。

markdown 使用星号（*）和底線（_）作為标記強調字詞的符号，被 * 或 _ 包圍的字詞會被轉成用  标簽包圍，用兩個 * 或_ 包起來的話，則會被轉成 ，例如：

會轉成：

你可以随便用你喜歡的樣式，唯一的限制是，你用什麼符号開啟标簽，就要用什麼符号結束。

強調也可以直接插在文字中間：

但是如果你的 * 和 _ 兩邊都有空白的話，它們就隻會被當成普通的符号。

如果要在文字前後直接插入普通的星号或底線，你可以用反斜線：

如果要标記一小段行内代碼，你可以用反引号把它包起來（`），例如：

use the printf() function.

如果要在代碼區段内插入反引号，你可以用多個反引号來開啟和結束代碼區段：

這段文法會産生：

there is a literal backtick (`) here.

代碼區段的起始和結束端都可以放入一個空白，起始端後面一個，結束端前面一個，這樣你就可以在區段的一開始就插入反引号：

a single backtick in a code span: `

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

在代碼區段内，&amp; 和方括号都會被自動地轉成 html 實體，這使得插入 html 原始碼變得很容易，markdown 會把下面這段：

轉為：

please don't use any &lt;blink&gt; tags.

你也可以這樣寫：

以産生：

&amp;#8212; is the decimal-encoded equivalent of &amp;mdash;.

很明顯地，要在純文字應用中設計一個「自然」的文法來插入圖檔是有一定難度的。

markdown 使用一種和連結很相似的文法來标記圖檔，同樣也允許兩種樣式： 行内式和參考式。

行内式的圖檔文法看起來像是：

詳細叙述如下：

一個驚歎号 !

接着一個方括号，裡面放上圖檔的替代文字

接着一個普通括号，裡面放上圖檔的網址，最後還可以用引号包住并加上 選擇性的 'title' 文字。

參考式的圖檔文法則長得像這樣：

「id」是圖檔參考的名稱，圖檔參考的定義方式則和連結參考一樣：

到目前為止， markdown 還沒有辦法指定圖檔的寬高，如果你需要的話，你可以使用普通的  标簽。

markdown 支援以比較簡短的自動連結形式來處理網址和電子郵件信箱，隻要是用方括号包起來， markdown 就會自動把它轉成連結。一般網址的連結文字就和連結位址一樣，例如：

markdown 會轉為：

郵址的自動連結也很類似，隻是 markdown 會先做一個編碼轉換的過程，把文字字元轉成 16 進位碼的 html 實體，這樣的格式可以糊弄一些不好的郵址收集機器人，例如：

markdown 會轉成：

（這種作法雖然可以糊弄不少的機器人，但并不能全部擋下來，不過總比什麼都不做好些。不管怎樣，公開你的信箱終究會引來廣告信件的。）

markdown 可以利用反斜杠來插入一些在文法中有其它意義的符号，例如：如果你想要用星号加在文字旁邊的方式來做出強調效果（但不用  标簽），你可以在星号的前面加上反斜杠：

markdown 支援以下這些符号前面加上反斜杠來幫助插入普通的符号：

windows 平台

<a href="http://markdownpad.com/" target="_blank">markdownpad</a>

<a href="http://code52.org/downmarkerwpf/" target="_blank">markpad</a>

linux 平台

<a href="http://sourceforge.net/p/retext/home/retext/" target="_blank">retext</a>

mac 平台

<a href="http://mouapp.com/" target="_blank">mou</a>

線上編輯器

<a href="http://markable.in/" target="_blank">markable.in</a>

<a href="http://dillinger.io/" target="_blank">dillinger.io</a>

浏覽器插件

進階應用

原文釋出時間為：2013-09-16

本文來自雲栖社群合作夥伴“linux中國”