標題
Markdown 支持兩種標題的語法朝抖,類 Setext 和類 atx 形式呼奢。
類 Setext 形式是用底線的形式转唉,利用 =
(最高階標題)和 -
(第二階標題)网严,例如:
This is an H1=============This is an H2-------------
任何數(shù)量的 =
和 -
都可以有效果。
類 Atx 形式則是在行首插入 1 到 6 個 #
艳汽,對應(yīng)到標題 1 到 6 階猴贰,例如:
這是 H1
這是 H2
這是 H6
你可以選擇性地「閉合」類 atx 樣式的標題,這純粹只是美觀用的河狐,若是覺得這樣看起來比較舒適米绕,你就可以在行尾加上 #
,而行尾的#
數(shù)量也不用和開頭一樣(行首的井字符數(shù)量決定標題的階數(shù)):
這是 H1
這是 H2
這是 H3
這是 H4
區(qū)塊引用 Blockquotes
Markdown 標記區(qū)塊引用是使用類似 email 中用 >
的引用方式馋艺。如果你還熟悉在 email 信件中的引言部分栅干,你就知道怎么在 Markdown 文件中建立一個區(qū)塊引用,那會看起來像是你自己先斷好行捐祠,然后在每行的最前面加上 >
:
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.
區(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 語法,包括標題踱蛀、列表窿给、代碼區(qū)塊等:
這是一個標題。
- 這是第一行列表項率拒。
- 這是第二行列表項崩泡。
給出一些例子代碼:> > return shell_exec("echo $input | $markdown_script");
任何像樣的文本編輯器都能輕松地建立 email 型的引用。例如在 BBEdit 中猬膨,你可以選取文字后然后從選單中選擇增加引用階層角撞。
列表
Markdown 支持有序列表和無序列表。
無序列表使用星號勃痴、加號或是減號作為列表標記:
- Red
- Green
- Blue
等同于:
- Red
- Green
- Blue
也等同于:
- Red
- Green
- Blue
有序列表則使用數(shù)字接著一個英文句點:
- Bird2. McHale3. Parish
很重要的一點是谒所,你在列表標記上使用的數(shù)字并不會影響輸出的 HTML 結(jié)果,上面的列表所產(chǎn)生的 HTML 標記為:
<ol><li>Bird</li><li>McHale</li><li>Parish</li></ol>
如果你的列表標記寫成:
- Bird1. McHale1. Parish
或甚至是:
- Bird1. McHale8. Parish
你都會得到完全相同的 HTML 輸出沛申。重點在于劣领,你可以讓 Markdown 文件的列表數(shù)字和輸出的結(jié)果相同,或是你懶一點污它,你可以完全不用在意數(shù)字的正確性剖踊。
如果你使用懶惰的寫法庶弃,建議第一個項目最好還是從 1. 開始衫贬,因為 Markdown 未來可能會支持有序列表的 start 屬性。
列表項目標記通常是放在最左邊歇攻,但是其實也可以縮進固惯,最多 3 個空格,項目標記后面則一定要接著至少一個空格或制表符缴守。
要讓列表看起來更漂亮葬毫,你可以把內(nèi)容用固定的縮進整理好:
- 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 就會將項目內(nèi)容用 <p>
標簽包起來贴捡,舉例來說:
- 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 個制表符:
- 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)然屹逛,再次地,如果你很懶惰汛骂,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.
如果要在列表項目內(nèi)放進引用罕模,那 >
就需要縮進:
- A list item with a blockquote: > This is a blockquote > inside a list item.
如果要放代碼區(qū)塊的話,該區(qū)塊就需要縮進兩次帘瞭,也就是 8 個空格或是 2 個制表符:
- 一列表項包含一個列表區(qū)塊: <代碼寫在這>
當(dāng)然淑掌,項目列表很可能會不小心產(chǎn)生,像是下面這樣的寫法:
- What a great season.
換句話說蝶念,也就是在行首出現(xiàn)數(shù)字-句點-空白抛腕,要避免這樣的狀況,你可以在句點前面加上反斜杠媒殉。
1986. What a great season.
代碼區(qū)塊
和程序相關(guān)的寫作或是標簽語言原始碼通常會有已經(jīng)排版好的代碼區(qū)塊兽埃,通常這些區(qū)塊我們并不希望它以一般段落文件的方式去排版,而是照原來的樣子顯示适袜,Markdown 會用 <pre>
和 <code>
標簽來把代碼區(qū)塊包起來柄错。
要在 Markdown 中建立代碼區(qū)塊很簡單,只要簡單地縮進 4 個空格或是 1 個制表符就可以苦酱,例如售貌,下面的輸入:
這是一個普通段落: 這是一個代碼區(qū)塊。
Markdown 會轉(zhuǎn)換成:
<p>這是一個普通段落:</p><pre><code>這是一個代碼區(qū)塊疫萤。</code></pre>
這個每行一階的縮進(4 個空格或是 1 個制表符)颂跨,都會被移除,例如:
Here is an example of AppleScript: tell application "Foo" beep end tell
會被轉(zhuǎn)換為:
<p>Here is an example of AppleScript:</p><pre><code>tell application "Foo" beepend tell</code></pre>
一個代碼區(qū)塊會一直持續(xù)到?jīng)]有縮進的那一行(或是文件結(jié)尾)扯饶。
在代碼區(qū)塊里面恒削, &
、 <
和 >
會自動轉(zhuǎn)成 HTML 實體尾序,這樣的方式讓你非常容易使用 Markdown 插入范例用的 HTML 原始碼钓丰,只需要復(fù)制貼上,再加上縮進就可以了每币,剩下的 Markdown 都會幫你處理携丁,例如:
<div class="footer"> ? 2004 Foo Corporation </div>
會被轉(zhuǎn)換為:
<pre><code><div class="footer"> ? 2004 Foo Corporation</div></code></pre>
代碼區(qū)塊中,一般的 Markdown 語法不會被轉(zhuǎn)換兰怠,像是星號便只是星號梦鉴,這表示你可以很容易地以 Markdown 語法撰寫 Markdown 語法相關(guān)的文件李茫。
分隔線
你可以在一行中用三個以上的星號、減號肥橙、底線來建立一個分隔線魄宏,行內(nèi)不能有其他東西。你也可以在星號或是減號中間插入空格存筏。下面每種寫法都可以建立分隔線:
- *********- - ----------------------------------------
區(qū)段元素
鏈接
Markdown 支持兩種形式的鏈接語法: 行內(nèi)式和參考式兩種形式娜庇。
不管是哪一種,鏈接文字都是用 [方括號] 來標記方篮。
要建立一個行內(nèi)式的鏈接名秀,只要在方塊括號后面緊接著圓括號并插入網(wǎng)址鏈接即可,如果你還想要加上鏈接的 title 文字藕溅,只要在網(wǎng)址后面匕得,用雙引號把 title 文字包起來即可,例如:
This is an example inline link.This link has no title attribute.
會產(chǎn)生:
<p>This is <a title="Title">an example</a> inline link.</p><p><a >This link</a> has notitle attribute.</p>
如果你是要鏈接到同樣主機的資源巾表,你可以使用相對路徑:
See my About page for details.
參考式的鏈接是在鏈接文字的括號后面再接上另一個方括號汁掠,而在第二個方括號里面要填入用以辨識鏈接的標記:
This is [an example][id] reference-style link.
你也可以選擇性地在兩個方括號中間加上一個空格:
This is [an example] [id] reference-style link.
接著,在文件的任意處集币,你可以把這個標記的鏈接內(nèi)容定義出來:
[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乞榨。
鏈接網(wǎng)址也可以用方括號包起來:
[id]: http://example.com/ "Optional Title Here"
你也可以把 title 屬性放到下一行,也可以加一些縮進当娱,若網(wǎng)址太長的話吃既,這樣會比較好看:
[id]: http://example.com/longish/path/to/resource/here "Optional Title Here"
網(wǎng)址定義只有在產(chǎn)生鏈接的時候用到,并不會直接出現(xiàn)在文件之中跨细。
鏈接辨別標簽可以有字母鹦倚、數(shù)字、空白和標點符號冀惭,但是并不區(qū)分大小寫震叙,因此下面兩個鏈接是一樣的:
[link text][a][link text][A]
隱式鏈接標記功能讓你可以省略指定鏈接標記,這種情形下散休,鏈接標記會視為等同于鏈接文字媒楼,要用隱式鏈接標記只要在鏈接文字后面加上一個空的方括號,如果你要讓 "Google" 鏈接到 google.com溃槐,你可以簡化成:
[Google][]
然后定義鏈接內(nèi)容:
[Google]: http://google.com/
由于鏈接文字可能包含空白匣砖,所以這種簡化型的標記內(nèi)也許包含多個單詞:
Visit [Daring Fireball][] for more information.
然后接著定義鏈接:
[Daring Fireball]: http://daringfireball.net/
鏈接的定義可以放在文件中的任何一個地方,我比較偏好直接放在鏈接出現(xiàn)段落的后面昏滴,你也可以把它放在文件最后面猴鲫,就像是注解一樣。
下面是一個參考式鏈接的范例:
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"
上面兩種寫法都會產(chǎn)生下面的 HTML谣殊。
<p>I get 10 times more traffic from <a href="http://google.com/"title="Google">Google</a> than from<a title="Yahoo Search">Yahoo</a>or <a title="MSN Search">MSN</a>.</p>
下面是用行內(nèi)式寫的同樣一段內(nèi)容的 Markdown 文件拂共,提供作為比較之用:
I get 10 times more traffic from Googlethan from Yahoo orMSN.
參考式的鏈接其實重點不在于它比較好寫,而是它比較好讀姻几,比較一下上面的范例宜狐,使用參考式的文章本身只有 81 個字符,但是用行內(nèi)形式的卻會增加到 176 個字元蛇捌,如果是用純 HTML 格式來寫抚恒,會有 234 個字元,在 HTML 格式中络拌,標簽比文本還要多俭驮。
使用 Markdown 的參考式鏈接,可以讓文件更像是瀏覽器最后產(chǎn)生的結(jié)果春贸,讓你可以把一些標記相關(guān)的元數(shù)據(jù)移到段落文字之外混萝,你就可以增加鏈接而不讓文章的閱讀感覺被打斷。
強調(diào)
Markdown 使用星號(*
)和底線(_
)作為標記強調(diào)字詞的符號萍恕,被 *
或 _
包圍的字詞會被轉(zhuǎn)成用 <em>
標簽包圍逸嘀,用兩個 *
或_
包起來的話,則會被轉(zhuǎn)成 <strong>
允粤,例如:
single asteriskssingle underscoresdouble asterisksdouble underscores
會轉(zhuǎn)成:
<em>single asterisks</em><em>single underscores</em><strong>double asterisks</strong><strong>double underscores</strong>
你可以隨便用你喜歡的樣式崭倘,唯一的限制是,你用什么符號開啟標簽类垫,就要用什么符號結(jié)束绳姨。
強調(diào)也可以直接插在文字中間:
unfriggingbelievable
但是如果你的 *
和 _
兩邊都有空白的話,它們就只會被當(dāng)成普通的符號阔挠。
如果要在文字前后直接插入普通的星號或底線飘庄,你可以用反斜線:
*this text is surrounded by literal asterisks*
代碼
如果要標記一小段行內(nèi)代碼,你可以用反引號把它包起來()购撼,例如: Use the
printf()` function.
會產(chǎn)生:
<p>Use the <code>printf()</code> function.</p>
如果要在代碼區(qū)段內(nèi)插入反引號跪削,你可以用多個反引號來開啟和結(jié)束代碼區(qū)段:
There is a literal backtick (`) here.
這段語法會產(chǎn)生:
<p><code>There is a literal backtick (`) here.</code></p>
代碼區(qū)段的起始和結(jié)束端都可以放入一個空白,起始端后面一個迂求,結(jié)束端前面一個碾盐,這樣你就可以在區(qū)段的一開始就插入反引號:
A single backtick in a code span: `
A backtick-delimited string in a code span: `foo`
會產(chǎn)生:
<p>A single backtick in a code span: <code></code></p><p>A backtick-delimited string in a code span: <code>
foo`</code></p>
在代碼區(qū)段內(nèi),&
和方括號都會被自動地轉(zhuǎn)成 HTML 實體揩局,這使得插入 HTML 原始碼變得很容易毫玖,Markdown 會把下面這段:
Please don't use any <blink>
tags.
轉(zhuǎn)為:
<p>Please don't use any <code><blink></code> tags.</p>
你也可以這樣寫:
—
is the decimal-encoded equivalent of —
.
以產(chǎn)生:
<p><code>—</code> is the decimal-encodedequivalent of <code>—</code>.</p>
圖片
很明顯地,要在純文字應(yīng)用中設(shè)計一個「自然」的語法來插入圖片是有一定難度的。
Markdown 使用一種和鏈接很相似的語法來標記圖片付枫,同樣也允許兩種樣式: 行內(nèi)式和參考式烹玉。
行內(nèi)式的圖片語法看起來像是:
![Alt text](/path/to/img.jpg)
![Alt text](/path/to/img.jpg)
詳細敘述如下:
一個驚嘆號 !
接著一個方括號,里面放上圖片的替代文字
接著一個普通括號阐滩,里面放上圖片的網(wǎng)址二打,最后還可以用引號包住并加上 選擇性的 'title' 文字。
參考式的圖片語法則長得像這樣:
![Alt text][id]
「id」是圖片參考的名稱掂榔,圖片參考的定義方式則和連結(jié)參考一樣:
[id]: url/to/image "Optional title attribute"
到目前為止继效, Markdown 還沒有辦法指定圖片的寬高,如果你需要的話装获,你可以使用普通的 <img>
標簽瑞信。
其它
自動鏈接
Markdown 支持以比較簡短的自動鏈接形式來處理網(wǎng)址和電子郵件信箱,只要是用方括號包起來穴豫, Markdown 就會自動把它轉(zhuǎn)成鏈接凡简。一般網(wǎng)址的鏈接文字就和鏈接地址一樣,例如:
http://example.com/
Markdown 會轉(zhuǎn)為:
<a >http://example.com/</a>
郵址的自動鏈接也很類似绩郎,只是 Markdown 會先做一個編碼轉(zhuǎn)換的過程潘鲫,把文字字符轉(zhuǎn)成 16 進位碼的 HTML 實體,這樣的格式可以糊弄一些不好的郵址收集機器人肋杖,例如:
address@example.com
Markdown 會轉(zhuǎn)成:
<a href="mailto:address@example.com">address@example.com</a>
在瀏覽器里面溉仑,這段字串(其實是 <a href="mailto:address@example.com">address@example.com</a>
)會變成一個可以點擊的「address@example.com」鏈接。
(這種作法雖然可以糊弄不少的機器人状植,但并不能全部擋下來浊竟,不過總比什么都不做好些。不管怎樣津畸,公開你的信箱終究會引來廣告信件的振定。)
反斜杠
Markdown 可以利用反斜杠來插入一些在語法中有其它意義的符號,例如:如果你想要用星號加在文字旁邊的方式來做出強調(diào)效果(但不用 <em>
標簽)肉拓,你可以在星號的前面加上反斜杠:
*literal asterisks*
Markdown 支持以下這些符號前面加上反斜杠來幫助插入普通的符號:
\ 反斜線` 反引號* 星號_ 底線{} 花括號[] 方括號() 括弧# 井字號+ 加號- 減號. 英文句點! 驚嘆號
感謝