Kurt - Markdown練習之Markdown語法說明

Markdown: Syntax

  • 哲學
  • 行內 HTML
  • 特殊字符自動轉換
  • 區塊元素
  • 段落和換行
  • 標題
  • 區塊引言
  • 列表
  • 程序代碼區塊
  • 分隔線
  • 區段元素
  • 鏈接
  • 強調
  • 程序代碼
  • 圖片
  • 其它
  • 轉義字符
  • 自動鏈接
  • 感謝

注意：這份文檔是用 Markdown 寫的，你可以看看附件中的原始文檔 。

<h1 id="1.1.1">概述</h1>

哲學

Markdown 的目標是實現「易讀易寫」。
不過最需要強調的便是它的可讀性。一份使用 Markdown 格式撰寫的文檔應該可以直接以純文本發布，并且看起來不會像是由許多標簽或是格式指令所構成。Markdown 語法受到一些既有 text-to-HTML 格式的影響，包括 Setext、atx、Textile、reStructuredText、Grutatext 和 EtText，然而最大靈感來源其實是純文本的電子郵件格式。
因此 Markdown 的語法全由標點符號所組成，并經過嚴謹慎選，是為了讓它們看起來就像所要表達的意思。像是在文字兩旁加上星號，看起來就像強調。Markdown 的列表看起來，嗯，就是列表。假如你用過電子郵件，區塊引言看起來就真的像是引用一段文字。

行內 HTML

Markdown 的語法有個主要的目的：用來作為一種網絡內容的寫作用語言。
Markdown 不是要來取代 HTML，甚至也沒有要和它相似，它的語法種類不多，只和 HTML 的一部分有關系，重點不是要創造一種更容易寫作 HTML 文檔的語法，我認為 HTML 已經很容易寫了，Markdown 的重點在于，它能讓文檔更容易閱讀、編寫。HTML 是一種發布的格式，Markdown 是一種編寫的格式，因此，Markdown 的格式語法只涵蓋純文本可以涵蓋的范圍。
不在 Markdown 涵蓋范圍之內的標簽，都可以直接在文檔里面用 HTML 撰寫。不需要額外標注這是 HTML 或是 Markdown；只要直接加標簽就可以了。
只有區塊元素──比如 <div> 、<table> 、<pre> 、<p> 等標簽，必需在前后加上空白，以利與內容區隔。而且這些（元素）的開始與結尾標簽，不可以用 tab 或是空白來縮排。Markdown 的產生器有智能判斷，可以避免在區塊標簽前后加上沒有必要的 <p> 標簽。
舉例來說，在 Markdown 文檔里加上一段 HTML 表格：

This is a regular paragraph.
<table>
    <tr>
        <td>Foo</td>
    </tr>
</table>
This is another regular paragraph.

請注意，Markdown 語法在 HTML 區塊標簽中將不會被進行處理。例如，無法在 HTML 區塊內使用 Markdown 形式的*強調*。
HTML 的區段標簽如 <span>、<cite>、<del> 則不受限制，可以在 Markdown 的段落、列表或是標題里任意使用。依照個人習慣，甚至可以不用Markdown 格式，而采用 HTML 標簽來格式化。舉例說明：如果比較喜歡 HTML 的 <a> 或 <img> 標簽，可以直接使用這些標簽，而不用 Markdown 提供的鏈接或是圖片標示語法。
HTML 區段標簽和區塊標簽不同，在區段標簽的范圍內，Markdown 的語法是有效的。

特殊字符自動轉換

在 HTML 文檔中，有兩個字符需要特殊處理： < 和 & 。 < 符號用于起始標簽，& 符號則用于標記 HTML 實體，如果只是想要使用這些符號，必須要使用實體的形式，像是 < 和 & 。
& 符號其實很讓寫作網絡文檔的人很困擾，如果要輸入「AT&T」 ，必須要寫成「AT&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 實體中使用 & 符號的話，它不會被轉換，而在其它情形下，它則會被轉換成 & 。所以如果要在文檔中插入一個著作權的符號，可以這樣寫：

?

Markdown 將不會對這段文字做修改，但是如果這樣寫：

AT&T

Markdown 就會將它轉為：

AT&T

類似的狀況也會發生在 < 符號上，因為 Markdown 支持 行內 HTML ，如果是使用 < 符號作為 HTML 標簽使用，那 Markdown 也不會對它做任何轉換，但是如果是寫：

4 < 5

Markdown 將會把它轉換為：

4 < 5

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

區塊元素

段落和換行

一個段落是由一個以上相連接的行句組成，而一個以上的空行則會切分出不同的段落（空行的定義是顯示上看起來像是空行，便會被視為空行。比方說，若某一行只包含空白和 tab，則該行也會被視為空行），一般的段落不需要用空白或斷行縮排。
「一個以上相連接的行句組成」這句話其實暗示了 Markdown 允許段落內的強迫斷行，這個特性和其他大部分的 text-to-HTML 格式不一樣（包括 MovableType 的「Convert Line Breaks」選項），其它的格式會把每個斷行都轉成 <br /> 標簽。
如果真的想要插入 <br /> 標簽，在行尾加上兩個以上的空白，然后按 enter。
是的，這確實需要花比較多功夫來插入 <br /> ，但是「每個換行都轉換為 <br /> 」的方法在 Markdown 中并不適合， Markdown 中 email 式的 區塊引言 和多段落的 列表 在使用換行來排版的時候，不但更好用，還更好閱讀。

標題

Markdown 支持兩種標題的語法，Setext 和 atx 形式。
Setext 形式是用底線的形式，利用 = （一級標題）和 - （二級標題），例如：

This is an H1
=============
This is an H2
-------------

任何數量的 = 和 - 都可以有效果。
Atx 形式則是在行首插入 1 到 6 個 # ，對應到標題 1 到 6 級，例如：

# This is an H1
## This is an H2
###### This is an H6

可以選擇性地「關閉」atx 樣式的標題，這純粹只是美觀用的，若是覺得這樣看起來比較舒適，就可以在行尾加上 # ，而行尾的 # 數量也不用和開頭一樣（行首的井字數量決定標題的級別）：

# This is an H1 
### This is an H2 
##### This is an 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. Suspendisseid sem consectetuer libero luctus adipiscing.

區塊引言可以有級別（例如：引言內的引言），只要根據級別加上不同數量的 > ：

This is the first level of quoting.

This is nested blockquote.

Back to the first level.

引言的區塊內也可以使用其他的 Markdown 語法，包括標題、列表、程序代碼區塊等：

This is a header.

  1. This is the first list item.
  2. This is the second list item.

Here's some example code:
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
  2. McHale
  3. Parish

或甚至是：

  1. Bird
  2. McHale
  3. Parish

都會得到完全相同的 HTML 輸出。重點在于，你可以讓 Markdown 文檔的列表數字和輸出的結果相同，或是懶一點，可以完全不用在意數字的正確性。
如果使用懶惰的寫法，建議第一個項目最好還是從 1. 開始，因為 Markdown 未來可能會支持有序列表的 start 屬性。
列表項目標記通常是放在最左邊，但是其實也可以縮排，最多三個空白，項目標記后面則一定要接著至少一個空白或 tab。
要讓列表看起來更漂亮，可以把內容用固定的縮排整理好：

  • 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.

如果列表項目間用空行分開， 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 個空白或是一個 tab ：

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'reonly required to indent the first line. Lorem ipsum dolorsit 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 個空白或是兩個 tab：
* A list item with a code block:
<code goes here>

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

1986. What a great season.

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

1986\. What a great season.

程序代碼區塊
和程序相關的寫作或是標簽語言原始代碼通常會有已經排版好的程序代碼區塊，通常這些區塊我們并不希望它以一般段落文檔的方式去排版，而是照原來的樣子顯示，Markdown 會用 <pre> 和<code> 標簽來把程序代碼區塊包起來。
要在 Markdown 中建立程序代碼區塊很簡單，只要簡單地縮排 4 個空白或是 1 個 tab 就可以，例如，下面的輸入：

This is a normal paragraph: 
    This is a code block.

Markdown 會轉換成：

<p>This is a normal paragraph:</p>
<pre><code>This is a code block.
</code></pre>

這個每行一級的縮排（4 個空白或是 1 個 tab），都會被移除，例如：

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" beepend tell
</code></pre>

一個程序代碼區塊會一直持續到沒有縮排的那一行（或是文檔結尾）。
在程序代碼區塊里面， & 、 <和 > 會自動轉成 HTML 實體，這樣的方式讓你非常容易使用 Markdown 插入范例用的 HTML 原始代碼，只需要復制貼上，再加上縮排就可以了，剩下的 Markdown 都會幫你處理，例如：

<div class="footer"> ? 2004 Foo Corporation </div>

會被轉換為：

<pre><code><div class="footer"> ? 2004 Foo Corporation</div></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 notitle 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"

鏈接定義的形式為：

  • 方括號，里面輸入鏈接的辨識用標簽
  • 接著一個冒號
  • 接著一個以上的空白或 tab
  • 接著鏈接的網址
  • 選擇性地接著 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]: <http://example.com/> "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 >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 asteriskssingle underscoresdouble asterisksdouble 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>

也可以這樣寫：

`—` is the decimal-encoded equivalent of `—`.

以產生：

<p><code>—</code> is the decimal-encoded
equivalent of <code>—</code>.</p>

圖片

很明顯地，要在純文本應用中設計一個 「自然」的語法來插入圖片是有一定難度的。
Markdown 使用一種和鏈接很相似的語法來標記圖片，同樣也允許兩種樣式： 行內和參考。
行內圖片的語法看起來像是：

Alt text
Alt text
Alt text
Alt text

詳細敘述如下：

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

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

![Alt text][id]

「id」是圖片參考的名稱，圖片參考的定義方式則和鏈接參考一樣：
[id]: url/to/image "Optional title attribute"

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

其他

自動鏈接

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

Markdown 會轉為：

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

自動的郵件鏈接也很類似，只是 Markdown 會先做一個編碼轉換的過程，把文字字符轉成 16 進位碼的 HTML 實體，這樣的格式可以混淆一些不好的信箱地址收集機器人，例如：
address@example.com

Markdown 會轉成：
<a href="mailto:address@example.com">address@example.com</a>

在瀏覽器里面，這段字符串會變成一個可以點擊的「address@example.com」鏈接。
（這種作法雖然可以混淆不少的機器人，但并無法全部擋下來，不過這樣也比什么都不做好些。無論如何，公開你的信箱終究會引來廣告信件的。）

轉義字符

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

\*literal asterisks\*

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

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

感謝
感謝 leafy7382 協助翻譯，hlb、Randylien 幫忙潤稿，ethantw 的漢字標準格式?CSS Reset，WM 回報文字錯誤。

最后編輯于 ：
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明：文章內容（如有圖片或視頻亦包括在內）由作者上傳并發布，文章內容僅代表作者本人觀點，簡書系信息發布平臺，僅提供信息存儲服務。

推薦閱讀更多精彩內容