前言
一直很想好好打理自己的博客,可是每次寫學(xué)習(xí)筆記之類的東東的時候都備受折磨。終于,在昨天,我遇見了Markdown,毫無疑問,它的簡潔性深深打動了我。我相信世界上一切的美都源于簡潔。
這篇文章記錄了Markdown的語法,主要參考Markdown 語法說明 (簡體中文版)。另外,這篇筆記也成為了我第一次用 Markdown 格式書寫的第一篇筆記。
簡介
Markdown是一種很簡潔的標(biāo)記語言,目標(biāo)是實現(xiàn)易讀易寫。
語法
段落
一個 Markdown 段落是由一個或多個連續(xù)的文本行組成,它的前后要有一個以上的空行(空行的定義是顯示上看起來像是空的,便會被視為空行。比方說,若某一行只包含空格和制表符,則該行也會被視為空行)。普通段落不該用空格或制表符來縮進。
標(biāo)題
Markdown 支持兩種標(biāo)題的語法,類 Setext 和類 atx 形式。
類 Setext 形式是用底線的形式,利用 = (最高階標(biāo)題)和 - (第二階標(biāo)題),例如:
This is an H1
=============
This is an H2
-------------
任何數(shù)量的 = 和 - 都可以有效果。
類 Atx 形式則是在行首插入 1 到 6 個 # ,對應(yīng)到標(biāo)題 1 到 6 階,例如:
# 這是 H1
## 這是 H2
###### 這是 H6
引用
Markdown 標(biāo)記區(qū)塊引用是使用類似 email 中用 > 的引用方式。例如:
> 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.
區(qū)塊引用可以嵌套(例如:引用內(nèi)的引用),只要根據(jù)層次加上不同數(shù)量的 > 。例如:
> This is the first level of quoting.
>
> > This is nested blockquote.
>
> Back to the first level
引用的區(qū)塊內(nèi)也可以使用其他的 Markdown 語法,包括標(biāo)題、列表、代碼區(qū)塊等:
> ## 這是一個標(biāo)題。
>
> 1. 這是第一行列表項。
> 2. 這是第二行列表項。
>
> 給出一些例子代碼:
>
> return shell_exec("echo $input | $markdown_script");
列表
Markdown 支持有序列表和無序列表。
無序列表通過星號、加號和減號來作為列表的標(biāo)記。
* Red
* Green
* Blue
等價于:
+ Reg
+ Green
+ Bule
等價于;
- Reg
- Green
- Bule
有序列表則使用數(shù)字接一個英文句點。
1. Reg
2. Green
3. Bule
很重要的一點是,你在列表標(biāo)記上使用的數(shù)字并不會影響輸出的 HTML 結(jié)果。
列表項目標(biāo)記通常是放在最左邊,但是其實也可以縮進,最多 3 個空格,項目標(biāo)記后面則一定要接著至少一個空格或制表符。
如果列表項目間用空行分開,在輸出 HTML 時 Markdown 就會將項目內(nèi)容用 <p> 標(biāo)簽包起來,舉例來說:
* Bird
* Magic
會被轉(zhuǎn)化為:
<ul>
<li>Bird</li>
<li>Magic</li>
</ul>
但是這個:
* Bird
* Magic
會被轉(zhuǎn)化為:
<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.
當(dāng)然,項目列表很可能會不小心產(chǎn)生,像是下面這樣的寫法:
1986. What a great season.
換句話說,也就是在行首出現(xiàn)數(shù)字-句點-空白,要避免這樣的狀況,你可以在句點前面加上反斜杠。
1986\. What a great season.
代碼塊
和程序相關(guān)的寫作或是標(biāo)簽語言原始碼通常會有已經(jīng)排版好的代碼區(qū)塊,通常這些區(qū)塊我們并不希望它以一般段落文件的方式去排版,而是照原來的樣子顯示,Markdown 會用 <pre> 和 <code> 標(biāo)簽來把代碼區(qū)塊包起來。
要在 Markdown 中建立代碼區(qū)塊很簡單,只要簡單地縮進 4 個空格或是 1 個制表符就可以,例如,下面的輸入:
這是一個普通段落:
這是一個代碼區(qū)塊。
Markdown 會轉(zhuǎn)換為:
<p>這是一個普通段落:</p>
<pre><code>這是一個代碼區(qū)塊。
</code></pre>
在代碼區(qū)塊里面, & 、 < 和 > 會自動轉(zhuǎn)成 HTML 實體,這樣的方式讓你非常容易使用 Markdown 插入范例用的 HTML 原始碼,只需要復(fù)制貼上,再加上縮進就可以了,剩下的 Markdown 都會幫你處理。
你可以在一行中用三個以上的星號、減號、底線來建立一個分隔線,行內(nèi)不能有其他東西。你也可以在星號或是減號中間插入空格。下面每種寫法都可以建立分隔線:
* * *
***
*****
- - -
---------------------------------------
代碼
如果要標(biāo)記一小段行內(nèi)代碼,你可以用反引號把它包起來(`),例如:
Use the `printf()` function.
如果要在代碼區(qū)段內(nèi)插入反引號,你可以用多個反引號來開啟和結(jié)束代碼區(qū)段:
``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` ``
在代碼區(qū)段內(nèi),& 和方括號都會被自動地轉(zhuǎn)成 HTML 實體,這使得插入 HTML 原始碼變得很容易。
鏈接
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.
如果你是要鏈接到同樣主機的資源,你可以使用相對路徑:
See my [About](/about/) page for details.
參考式的鏈接是在鏈接文字的括號后面再接上另一個方括號,而在第二個方括號里面要填入用以辨識鏈接的標(biāo)記:
This is [an example][id] reference-style link.
你也可以選擇性地在兩個方括號中間加上一個空格:
[id]: http://example.com/ "Optional Title Here"
鏈接內(nèi)容定義的形式為:
- 方括號(前面可以選擇性地加上至多三個空格來縮進),里面輸入鏈接文字
- 接著一個冒號
- 接著一個以上的空格或制表符
- 接著鏈接的網(wǎng)址
- 選擇性地接著 title 內(nèi)容,可以用單引號、雙引號或是括弧包著
一下三種情況都是有效的:
[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。
鏈接辨別標(biāo)簽可以有字母、數(shù)字、空白和標(biāo)點符號,但是并不區(qū)分大小寫。
隱式鏈接標(biāo)記功能讓你可以省略指定鏈接標(biāo)記,這種情形下,鏈接標(biāo)記會視為等同于鏈接文字,要用隱式鏈接標(biāo)記只要在鏈接文字后面加上一個空的方括號,如果你要讓 "Google" 鏈接到 google.com,你可以簡化成:
[Google][]
然后定義鏈接內(nèi)容:
[Google]: http://google.com/
Markdown 使用星號(*)和底線(_)作為標(biāo)記強調(diào)字詞的符號,被 * 或 _ 包圍的字詞會被轉(zhuǎn)成用 <em> 標(biāo)簽包圍,用兩個 * 或 _ 包起來的話,則會被轉(zhuǎn)成 <strong>,例如:
*single asterisks*
_single underscores_
**double asterisks**
__double underscores__
但是如果你的 * 和 _ 兩邊都有空白的話,它們就只會被當(dāng)成普通的符號。
如果要在文字前后直接插入普通的星號或底線,你可以用反斜線:
\*this text is surrounded by literal asterisks\*
圖片
Markdown 使用一種和鏈接很相似的語法來標(biāo)記圖片,同樣也允許兩種樣式: 行內(nèi)式和參考式。
行內(nèi)式的圖片語法看起來像是:


詳細(xì)敘述如下:
- 一個驚嘆號 !
- 接著一個方括號,里面放上圖片的替代文字
- 接著一個普通括號,里面放上圖片的網(wǎng)址,最后還可以用引號包住并加上 選擇性的 'title'文字。
參考式的圖片語法則長得像這樣:
![Alt text][id]
「id」是圖片參考的名稱,圖片參考的定義方式則和連結(jié)參考一樣:
[id]: url/to/image "Optional title attribute"
自動鏈接
Markdown 支持以比較簡短的自動鏈接形式來處理網(wǎng)址和電子郵件信箱,只要是用方括號包起來, Markdown 就會自動把它轉(zhuǎn)成鏈接。一般網(wǎng)址的鏈接文字就和鏈接地址一樣,例如:
<http://example.com/>
會被轉(zhuǎn)換成為:
<a >http://example.com/</a>
郵址的自動鏈接也很類似,只是 Markdown 會先做一個編碼轉(zhuǎn)換的過程,把文字字符轉(zhuǎn)成 16 進位碼的 HTML 實體,這樣的格式可以糊弄一些不好的郵址收集機器人,例如:
<address@example.com>
會被轉(zhuǎn)換成為:
<a href="mailto:addre
ss@example.co
m">address@exa
mple.com</a>
在瀏覽器里面,這段字串(其實是 <a href="mailto:address@example.com">address@example.com</a>)會變成一個可以點擊的「address@example.com」鏈接。
反斜杠
Markdown 可以利用反斜杠來插入一些在語法中有其它意義的符號,例如:如果你想要用星號加在文字旁邊的方式來做出強調(diào)效果(但不用 <em> 標(biāo)簽),你可以在星號的前面加上反斜杠:
*iteral asterisks*
Markdown 支持以下這些符號前面加上反斜杠來幫助插入普通的符號:
\ 反斜線
` 反引號
* 星號
_ 底線
{} 花括號
[] 方括號
() 括弧
# 井字號
+ 加號
- 減號
. 英文句點
! 驚嘆號
日期
2013 年 1 月 25 日