宗旨

Markdown 的目標是實現「易讀易寫」。

可讀性,無論如何,都是最重要的。一份使用 Markdown 格式撰寫的文件應該可以直接以純文本發布,并且看起來不會像是由許多標簽或是格式指令所構成。Markdown 語法受到一些既有 text-to-HTML 格式的影響,包括 SetextatxTextilereStructuredTextGrutatextEtText,而最大靈感來源其實是純文本電子郵件的格式。

兼容 HTML

Markdown 語法的目標是:成為一種適用于網絡的書寫語言。

Markdown 不是想要取代 HTML,甚至也沒有要和它相近,它的語法種類很少,只對應 HTML 標記的一小部分。Markdown 的構想不是要使得 HTML 文檔更容易書寫。在我看來, HTML 已經很容易寫了。Markdown 的理念是,能讓文檔更容易讀、寫和隨意改。HTML 是一種發布的格式,Markdown 是一種書寫的格式。就這樣,Markdown 的格式語法只涵蓋純文本可以涵蓋的范圍。

不在 Markdown 涵蓋范圍之內的標簽,都可以直接在文檔里面用 HTML 撰寫。不需要額外標注這是 HTML 或是 Markdown;只要直接加標簽就可以了。

要制約的只有一些 HTML 區塊元素――比如 <div>、<table>、<pre>、<p> 等標簽,必須在前后加上空行與其它內容區隔開,還要求它們的開始標簽與結尾標簽不能用制表符或空格來縮進。Markdown 的生成器有足夠智能,不會在 HTML 區塊標簽外加上不必要的 <p> 標簽。

例子如下,在 Markdown 文件里加上一段 HTML 表格:

這是一個普通段落。

<table>
    <tr>
        <td>Foo</td>
    </tr>
</table>

這是另一個普通段落。

請注意,在 HTML 區塊標簽間的 Markdown 格式語法將不會被處理。比如,你在 HTML 區塊內使用 Markdown 樣式的*強調*會沒有效果。

HTML 的區段(行內)標簽如 <span>、<cite>、<del> 可以在 Markdown 的段落、列表或是標題里隨意使用。依照個人習慣,甚至可以不用 Markdown 格式,而直接采用 HTML 標簽來格式化。舉例說明:如果比較喜歡 HTML 的 <a> 或 <img> 標簽,可以直接使用這些標簽,而不用 Markdown 提供的鏈接或是圖像標簽語法。

和處在 HTML 區塊標簽間不同,Markdown 語法在 HTML 區段標簽間是有效的。

特殊字符自動轉換

在 HTML 文件中,有兩個字符需要特殊處理: < 和 & 。 < 符號用于起始標簽,& 符號則用于標記 HTML 實體,如果你只是想要顯示這些字符的原型,你必須要使用實體的形式,像是 &lt; 和 &amp;。

& 字符尤其讓網絡文檔編寫者受折磨,如果你要打「AT&T」 ,你必須要寫成「AT&amp;T」。而網址中的 & 字符也要轉換。比如你要鏈接到:

http://images.google.com/images?num=30&q=larry+bird

你必須要把網址轉換寫為:

http://images.google.com/images?num=30&q=larry+bird

才能放到鏈接標簽的 href 屬性里。不用說也知道這很容易忽略,這也可能是 HTML 標準檢驗所檢查到的錯誤中,數量最多的。

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

所以你如果要在文檔中插入一個版權符號©,你可以這樣寫:

&copy;

Markdown 會保留它不動。而若你寫:

AT&T

Markdown 就會將它轉為:

AT&amp;T

類似的狀況也會發生在 < 符號上,因為 Markdown 允許 兼容 HTML ,如果你是把 < 符號作為 HTML 標簽的定界符使用,那 Markdown 也不會對它做任何轉換,但是如果你寫:

4 < 5

Markdown 將會把它轉換為:

4 &lt; 5

不過需要注意的是,code 范圍內,不論是行內還是區塊, < 和 & 兩個符號都一定會被轉換成 HTML 實體,這項特性讓你可以很容易地用 Markdown 寫 HTML code (和 HTML 相對而言, HTML 語法中,你要把所有的 < 和 & 都轉換為 HTML 實體,才能在 HTML 文件里面寫出 HTML code。)

段落和換行

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

「由一個或多個連續的文本行組成」這句話其實暗示了 Markdown 允許段落內的強迫換行(插入換行符),這個特性和其他大部分的 text-to-HTML 格式不一樣(包括 Movable Type 的「Convert Line Breaks」選項),其它的格式會把每個換行符都轉成 <br /> 標簽。

如果你確實想要依賴 Markdown 來插入 <br /> 標簽的話,在插入處先按入兩個以上的空格然后回車。

的確,需要多費點事(多加空格)來產生 <br /> ,但是簡單地「每個換行都轉換為 <br />」的方法在 Markdown 中并不適合, Markdown 中 email 式的 區塊引用 和多段落的 列表 在使用換行來排版的時候,不但更好用,還更方便閱讀。

標題

Markdown 支持兩種標題的語法,類 Setext 和類 atx 形式。

類 Setext 形式是用底線的形式,利用 = (最高階標題)和 - (第二階標題),例如:

This is an H1
=============

This is an H2
-------------

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

類 Atx 形式則是在行首插入 1 到 6 個 # ,對應到標題 1 到 6 階,例如:

# 這是 H1

## 這是 H2

###### 這是 H6

你可以選擇性地「閉合」類 atx 樣式的標題,這純粹只是美觀用的,若是覺得這樣看起來比較舒適,你就可以在行尾加上 #,而行尾的 # 數量也不用和開頭一樣(行首的井字符數量決定標題的階數):

# 這是 H1 #

## 這是 H2 ##

### 這是 H3 ######

區塊引用Blockquotes

Markdown 標記區塊引用是使用類似 email 中用 > 的引用方式。如果你還熟悉在 email 信件中的引言部分,你就知道怎么在 Markdown 文件中建立一個區塊引用,那會看起來像是你自己先斷好行,然后在每行的最前面加上 > :

> This is a blockquote 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. Suspendisse
> id sem consectetuer libero luctus adipiscing.

Markdown 也允許你偷懶只在整個段落的第一行最前面加上 > :

> This is a blockquote 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. Suspendisse
id sem consectetuer libero luctus adipiscing.

區塊引用可以嵌套(例如:引用內的引用),只要根據層次加上不同數量的 > :

 This is the first level of quoting.
>
> > This is nested blockquote.
>
> Back to the first level.

引用的區塊內也可以使用其他的 Markdown 語法,包括標題、列表、代碼區塊等:

> ## 這是一個標題。
> 
> 1.   這是第一行列表項。
> 2.   這是第二行列表項。
> 
> 給出一些例子代碼:
> 
>     return shell_exec("echo $input | $markdown_script");

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

列表

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

無序列表使用星號、加號或是減號作為列表標記:

*   Red
*   Green
*   Blue

等同于:

+   Red
+   Green
+   Blue

也等同于:

-   Red
-   Green
-   Blue

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

1.  Bird
2.  McHale
3.  Parish

很重要的一點是,你在列表標記上使用的數字并不會影響輸出的 HTML 結果,上面的列表所產生的 HTML 標記為:

<ol>
<li>Bird</li>
<li>McHale</li>
<li>Parish</li>
</ol>

如果你的列表標記寫成:

1.  Bird
1.  McHale
1.  Parish

或甚至是:

3. Bird
1. McHale
8. Parish

你都會得到完全相同的 HTML 輸出。重點在于,你可以讓 Markdown 文件的列表數字和輸出的結果相同,或是你懶一點,你可以完全不用在意數字的正確性。

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

列表項目標記通常是放在最左邊,但是其實也可以縮進,最多 3 個空格,項目標記后面則一定要接著至少一個空格或制表符。

要讓列表看起來更漂亮,你可以把內容用固定的縮進整理好:

*   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.
    Suspendisse id sem consectetuer libero luctus adipiscing.

但是如果你懶,那也行:

*   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.
Suspendisse id sem consectetuer libero luctus adipiscing.

如果列表項目間用空行分開,在輸出 HTML 時 Markdown 就會將項目內容用 <p> 標簽包起來,舉例來說:

*   Bird
*   Magic

會被轉換為:

<ul>
<li>Bird</li>
<li>Magic</li>
</ul>

但是這個:

*   Bird

*   Magic

會被轉換為:

<ul>
<li><p>Bird</p></li>
<li><p>Magic</p></li>
</ul>

列表項目可以包含多個段落,每個項目下的段落都必須縮進 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.

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

*   This is a list item with two paragraphs.

    This is the second paragraph in the list item. You're
only required to indent the first line. Lorem ipsum dolor
sit amet, consectetuer adipiscing elit.

*   Another item in the same list.

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

*   A list item with a blockquote:

    > This is a blockquote
    > inside a list item.

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

*   一列表項包含一個列表區塊:

        <代碼寫在這>

當然,項目列表很可能會不小心產生,像是下面這樣的寫法

1986. What a great season.

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

1986\. What a great season.

代碼區塊

和程序相關的寫作或是標簽語言原始碼通常會有已經排版好的代碼區塊,通常這些區塊我們并不希望它以一般段落文件的方式去排版,而是照原來的樣子顯示,Markdown 會用 <pre> 和 <code> 標簽來把代碼區塊包起來。

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

這是一個普通段落:

    這是一個代碼區塊。

Markdown 會轉換成:

<p>這是一個普通段落:</p>

<pre><code>這是一個代碼區塊。
</code></pre>

這個每行一階的縮進(4 個空格或是 1 個制表符),都會被移除,例如:

Here is an example of AppleScript:

    tell application "Foo"
        beep
    end tell

會被轉換為:

<p>Here is an example of AppleScript:</p>

<pre><code>tell application "Foo"
    beep
end tell
</code></pre>

一個代碼區塊會一直持續到沒有縮進的那一行(或是文件結尾)。

在代碼區塊里面, & 、 < 和 > 會自動轉成 HTML 實體,這樣的方式讓你非常容易使用 Markdown 插入范例用的 HTML 原始碼,只需要復制貼上,再加上縮進就可以了,剩下的 Markdown 都會幫你處理,例如:

<div class="footer">
  &copy; 2004 Foo Corporation
</div>

會被轉換為:

<pre><code>&lt;div class="footer"&gt;
    &amp;copy; 2004 Foo Corporation
&lt;/div&gt;
</code></pre>

代碼區塊中,一般的 Markdown 語法不會被轉換,像是星號便只是星號,這表示你可以很容易地以 Markdown 語法撰寫 Markdown 語法相關的文件。

分隔線

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

* * *

***

*****

- - -

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

Markdown 支持兩種形式的鏈接語法: 行內式和參考式兩種形式。

不管是哪一種,鏈接文字都是用 [方括號] 來標記。

要建立一個行內式的鏈接,只要在方塊括號后面緊接著圓括號并插入網址鏈接即可,如果你還想要加上鏈接的 title 文字,只要在網址后面,用雙引號把 title 文字包起來即可,例如:

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

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

會產生:

<p>This is <a  title="Title">
an example</a> inline link.</p>

<p><a >This link</a> has no
title attribute.</p>

如果你是要鏈接到同樣主機的資源,你可以使用相對路徑:

See my [About](/about/) page for details.

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

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

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

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

接著,在文件的任意處,你可以把這個標記的鏈接內容定義出來:

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

鏈接內容定義的形式為:

  • 方括號(前面可以選擇性地加上至多三個空格來縮進),里面輸入鏈接文字
  • 接著一個冒號
  • 接著一個以上的空格或制表符
  • 接著鏈接的網址
  • 選擇性地接著 title 內容,可以用單引號、雙引號或是括弧包著

下面這三種鏈接的定義都是相同:

[foo]: http://example.com/  "Optional Title Here"
[foo]: http://example.com/  'Optional Title Here'
[foo]: http://example.com/  (Optional Title Here)

請注意:有一個已知的問題是 Markdown.pl 1.0.1 會忽略單引號包起來的鏈接 title。

鏈接網址也可以用方括號包起來:

[id]: "Optional Title Here"

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

[id]: http://example.com/longish/path/to/resource/here
    "Optional Title Here"

網址定義只有在產生鏈接的時候用到,并不會直接出現在文件之中。

鏈接辨別標簽可以有字母、數字、空白和標點符號,但是并不區分大小寫,因此下面兩個鏈接是一樣的:

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

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

[Google][]

然后定義鏈接內容:

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

由于鏈接文字可能包含空白,所以這種簡化型的標記內也許包含多個單詞:

Visit [Daring Fireball][] for more information.

然后接著定義鏈接

[Daring Fireball]: http://daringfireball.net/

鏈接的定義可以放在文件中的任何一個地方,我比較偏好直接放在鏈接出現段落的后面,你也可以把它放在文件最后面,就像是注解一樣。

下面是一個參考式鏈接的范例:

I get 10 times more traffic from [Google] [1] than from
[Yahoo] [2] or [MSN] [3].

  [1]: http://google.com/        "Google"
  [2]: http://search.yahoo.com/  "Yahoo Search"
  [3]: http://search.msn.com/    "MSN Search"

如果改成用鏈接名稱的方式寫:

I get 10 times more traffic from [Google][] than from
[Yahoo][] or [MSN][].

  [google]: http://google.com/        "Google"
  [yahoo]:  http://search.yahoo.com/  "Yahoo Search"
  [msn]:    http://search.msn.com/    "MSN Search"

上面兩種寫法都會產生下面的 HTML。

<p>I get 10 times more traffic from <a 
title="Google">Google</a> than from
<a  title="Yahoo Search">Yahoo</a>
or <a  title="MSN Search">MSN</a>.</p>

下面是用行內式寫的同樣一段內容的 Markdown 文件,提供作為比較之用:

I get 10 times more traffic from [Google](http://google.com/ "Google")
than from [Yahoo](http://search.yahoo.com/ "Yahoo Search") or
[MSN](http://search.msn.com/ "MSN Search").

參考式的鏈接其實重點不在于它比較好寫,而是它比較好讀,比較一下上面的范例,使用參考式的文章本身只有 81 個字符,但是用行內形式的卻會增加到 176 個字元,如果是用純 HTML 格式來寫,會有 234 個字元,在 HTML 格式中,標簽比文本還要多。

使用 Markdown 的參考式鏈接,可以讓文件更像是瀏覽器最后產生的結果,讓你可以把一些標記相關的元數據移到段落文字之外,你就可以增加鏈接而不讓文章的閱讀感覺被打斷。

強調

Markdown 使用星號(*)和底線(_)作為標記強調字詞的符號,被 * 或 _ 包圍的字詞會被轉成用 <em> 標簽包圍,用兩個 * 或 _ 包起來的話,則會被轉成 <strong>,例如:

*single asterisks*

_single underscores_

**double asterisks**

__double underscores__

會轉成:

<em>single asterisks</em>

<em>single underscores</em>

<strong>double asterisks</strong>

<strong>double underscores</strong>

你可以隨便用你喜歡的樣式,唯一的限制是,你用什么符號開啟標簽,就要用什么符號結束。

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

un*frigging*believable

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

如果要在文字前后直接插入普通的星號或底線,你可以用反斜線:

\*this text is surrounded by literal asterisks\*

代碼

如果要標記一小段行內代碼,你可以用反引號把它包起來(`),例如:

Use the `printf()` function.

會產生:

<p>Use the <code>printf()</code> function.</p>

如果要在代碼區段內插入反引號,你可以用多個反引號來開啟和結束代碼區段:

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

這段語法會產生:

<p><code>There is a literal backtick (`) here.</code></p>

代碼區段的起始和結束端都可以放入一個空白,起始端后面一個,結束端前面一個,這樣你就可以在區段的一開始就插入反引號:

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

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

會產生:

<p>A single backtick in a code span: <code>`</code></p>

<p>A backtick-delimited string in a code span: <code>`foo`</code></p>

在代碼區段內,& 和方括號都會被自動地轉成 HTML 實體,這使得插入 HTML 原始碼變得很容易,Markdown 會把下面這段:

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

轉為:

<p>Please don't use any <code><blink></code> tags.</p>

你也可以這樣寫:

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

以產生:

<p><code>&amp;#8212;</code> is the decimal-encoded
equivalent of <code>&amp;mdash;</code>.</p>

圖片

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

Markdown 使用一種和鏈接很相似的語法來標記圖片,同樣也允許兩種樣式: 行內式和參考式。

行內式的圖片語法看起來像是:

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

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

詳細敘述如下:

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

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

![Alt text][id]

「id」是圖片參考的名稱,圖片參考的定義方式則和連結參考一樣:

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

到目前為止, Markdown 還沒有辦法指定圖片的寬高,如果你需要的話,你可以使用普通的 <img> 標簽。

反斜杠

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

\*literal asterisks\*

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

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

Markdown 支持以比較簡短的自動鏈接形式來處理網址和電子郵件信箱,只要是用方括號包起來, Markdown 就會自動把它轉成鏈接。一般網址的鏈接文字就和鏈接地址一樣,例如:

<http://example.com/>

Markdown 會轉為:

<a >http://example.com/</a>

郵址的自動鏈接也很類似,只是 Markdown 會先做一個編碼轉換的過程,把文字字符轉成 16 進位碼的 HTML 實體,這樣的格式可以糊弄一些不好的郵址收集機器人,例如:

Markdown 會轉成:

<a href="mailto:addre
ss@example.co
m">address@exa
mple.com</a>

在瀏覽器里面,這段字串(其實是 <a href="mailto:[email protected]">[email protected]</a>)會變成一個可以點擊的「[email protected]」鏈接。

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

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

Markdown 免費編輯器

Windows 平臺

Linux 平臺

Mac 平臺

在線編輯器

瀏覽器插件

高級應用(Sublime Text 2 + MarkdownEditing 教程)