該篇內(nèi)容來自 Github翰蠢,有興趣的可以給人家一個(gè)
star
綜合概述
宗旨
Markdown 的目標(biāo)是實(shí)現(xiàn)「易讀易寫」萌丈。
可讀性無論如何都是最重要的。一份使用 Markdown 格式撰寫的文件應(yīng)該可以直接以純文本發(fā)布,并且看起來不會(huì)像是由許多標(biāo)簽或是格式指令所構(gòu)成。Markdown 語法受到一些既有 text-to-HTML 格式的影響摘盆,包括 Setext蝇裤、atx巧勤、Textile惹想、reStructuredText、Grutatext 和 EtText森爽,而最大靈感來源其實(shí)是純文本電子郵件的格式恨豁。
總之, Markdown 的語法全由一些符號(hào)所組成爬迟,這些符號(hào)經(jīng)過精挑細(xì)選橘蜜,其作用一目了然。比如:在文字兩旁加上星號(hào)付呕,看起來就像強(qiáng)調(diào)计福。Markdown 的列表看起來,嗯凡涩,就是列表棒搜。Markdown 的區(qū)塊引用看起來就真的像是引用一段文字,就像你曾在電子郵件中見過的那樣活箕。
兼容 HTML
Markdown 語法的目標(biāo)是:成為一種適用于網(wǎng)絡(luò)的書寫語言力麸。
Markdown 不是想要取代 HTML,甚至也沒有要和它相近育韩,它的語法種類很少克蚂,只對(duì)應(yīng) HTML 標(biāo)記的一小部分。Markdown 的構(gòu)想不是要使得 HTML 文檔更容易書寫筋讨。在我看來埃叭, HTML 已經(jīng)很容易寫了。Markdown 的理念是悉罕,能讓文檔更容易讀赤屋、寫和隨意改。HTML 是一種發(fā)布的格式壁袄,Markdown 是一種書寫的格式类早。就這樣,Markdown 的格式語法只涵蓋純文本可以涵蓋的范圍嗜逻。
不在 Markdown 涵蓋范圍之內(nèi)的標(biāo)簽涩僻,都可以直接在文檔里面用 HTML 撰寫。不需要額外標(biāo)注這是 HTML 或是 Markdown;只要直接加標(biāo)簽就可以了逆日。
要制約的只有一些 HTML 區(qū)塊元素――比如 <div>嵌巷、<table>、<pre>室抽、<p> 等標(biāo)簽搪哪,必須在前后加上空行與其它內(nèi)容區(qū)隔開,還要求它們的開始標(biāo)簽與結(jié)尾標(biāo)簽不能用制表符或空格來縮進(jìn)狠半。Markdown 的生成器有足夠智能噩死,不會(huì)在 HTML 區(qū)塊標(biāo)簽外加上不必要的 <p> 標(biāo)簽颤难。
例子如下神年,在 Markdown 文件里加上一段 HTML 表格:
這是一個(gè)普通段落。
<table>
<tr>
<td>Foo</td>
</tr>
</table>這是另一個(gè)普通段落行嗤。
請(qǐng)注意已日,在 HTML 區(qū)塊標(biāo)簽間的 Markdown 格式語法將不會(huì)被處理。比如栅屏,你在 HTML 區(qū)塊內(nèi)使用 Markdown 樣式的強(qiáng)調(diào)會(huì)沒有效果飘千。
HTML 的區(qū)段(行內(nèi))標(biāo)簽如 <span>、<cite>栈雳、<del> 可以在 Markdown 的段落护奈、列表或是標(biāo)題里隨意使用。依照個(gè)人習(xí)慣哥纫,甚至可以不用 Markdown 格式霉旗,而直接采用 HTML 標(biāo)簽來格式化。舉例說明:如果比較喜歡 HTML 的 <a> 或 <img> 標(biāo)簽蛀骇,可以直接使用這些標(biāo)簽厌秒,而不用 Markdown 提供的鏈接或是圖像標(biāo)簽語法。
和處在 HTML 區(qū)塊標(biāo)簽間不同擅憔,Markdown 語法在 HTML 區(qū)段標(biāo)簽間是有效的鸵闪。
特殊字符自動(dòng)轉(zhuǎn)換
在 HTML 文件中,有兩個(gè)字符需要特殊處理: <
和 &
暑诸。 <
符號(hào)用于起始標(biāo)簽蚌讼,&
符號(hào)則用于標(biāo)記 HTML 實(shí)體,如果你只是想要顯示這些字符的原型个榕,你必須要使用實(shí)體的形式篡石,像是 <
和 &
。
&
字符尤其讓網(wǎng)絡(luò)文檔編寫者受折磨笛洛,如果你要打「AT&T
」 夏志,你必須要寫成「AT&T
」。而網(wǎng)址中的 &
字符也要轉(zhuǎn)換。比如你要鏈接到:
你必須要把網(wǎng)址轉(zhuǎn)換寫為:
才能放到鏈接標(biāo)簽的 href 屬性里沟蔑。不用說也知道這很容易忽略湿诊,這也可能是 HTML 標(biāo)準(zhǔn)檢驗(yàn)所檢查到的錯(cuò)誤中,數(shù)量最多的瘦材。
Markdown 讓你可以自然地書寫字符厅须,需要轉(zhuǎn)換的由它來處理好了。如果你使用的 & 字符是 HTML 字符實(shí)體的一部分食棕,它會(huì)保留原狀朗和,否則它會(huì)被轉(zhuǎn)換成 &。
所以你如果要在文檔中插入一個(gè)版權(quán)符號(hào) ?簿晓,你可以這樣寫:
© ;
Markdown 會(huì)保留它不動(dòng)眶拉。而若你寫:
AT&T
Markdown 就會(huì)將它轉(zhuǎn)為:
AT&T
類似的狀況也會(huì)發(fā)生在 <
符號(hào)上,因?yàn)?Markdown 允許 兼容 HTML 憔儿,如果你是把 <
符號(hào)作為 HTML 標(biāo)簽的定界符使用忆植,那 Markdown 也不會(huì)對(duì)它做任何轉(zhuǎn)換,但是如果你寫:
4 < 5
Markdown 將會(huì)把它轉(zhuǎn)換為:
4 < 5
不過需要注意的是谒臼,code 范圍內(nèi)朝刊,不論是行內(nèi)還是區(qū)塊, <
和 &
兩個(gè)符號(hào)都一定會(huì)被轉(zhuǎn)換成 HTML 實(shí)體蜈缤,這項(xiàng)特性讓你可以很容易地用 Markdown 寫 HTML code (和 HTML 相對(duì)而言拾氓, HTML 語法中,你要把所有的 <
和 &
都轉(zhuǎn)換為 HTML 實(shí)體底哥,才能在 HTML 文件里面寫出 HTML code咙鞍。)
區(qū)塊元素
段落和換行
一個(gè) Markdown 段落是由一個(gè)或多個(gè)連續(xù)的文本行組成,它的前后要有一個(gè)以上的空行(空行的定義是顯示上看起來像是空的叠艳,便會(huì)被視為空行奶陈。比方說,若某一行只包含空格和制表符附较,則該行也會(huì)被視為空行)吃粒。普通段落不該用空格或制表符來縮進(jìn)。
「由一個(gè)或多個(gè)連續(xù)的文本行組成」這句話其實(shí)暗示了 Markdown 允許段落內(nèi)的強(qiáng)迫換行(插入換行符)拒课,這個(gè)特性和其他大部分的 text-to-HTML 格式不一樣(包括 Movable Type 的「Convert Line Breaks」選項(xiàng))徐勃,其它的格式會(huì)把每個(gè)換行符都轉(zhuǎn)成 <br />
標(biāo)簽。
如果你確實(shí)想要依賴 Markdown 來插入 <br />
標(biāo)簽的話早像,在插入處先按入兩個(gè)以上的空格然后回車僻肖。
的確,需要多費(fèi)點(diǎn)事(多加空格)來產(chǎn)生 <br />
卢鹦,但是簡(jiǎn)單地「每個(gè)換行都轉(zhuǎn)換為 <br />
」的方法在 Markdown 中并不適合臀脏, Markdown 中 email 式的 區(qū)塊引用 和多段落的 列表 在使用換行來排版的時(shí)候,不但更好用,還更方便閱讀揉稚。
標(biāo)題
Markdown 支持兩種標(biāo)題的語法秒啦,類 Setext 和類 atx 形式。
類 Setext 形式是用底線的形式搀玖,利用 =
(最高階標(biāo)題)和 -
(第二階標(biāo)題)余境,例如:
This is an H1
=============
This is an H2
--
任何數(shù)量的 =
和 -
都可以有效果。
類 Atx 形式則是在行首插入 1 到 6 個(gè) #
灌诅,對(duì)應(yīng)到標(biāo)題 1 到 6 階芳来,例如:
這是 H1
這是 H2
這是 H6
你可以選擇性地「閉合」類 atx 樣式的標(biāo)題,這純粹只是美觀用的猜拾,若是覺得這樣看起來比較舒適即舌,你就可以在行尾加上 #
,而行尾的 #
數(shù)量也不用和開頭一樣(行首的井字符數(shù)量決定標(biāo)題的階數(shù)):
這是 H1
這是 H2
這是 H3
區(qū)塊引用 Blockquotes
Markdown 標(biāo)記區(qū)塊引用是使用類似 email 中用 >
的引用方式关带。如果你還熟悉在 email 信件中的引言部分侥涵,你就知道怎么在 Markdown 文件中建立一個(gè)區(qū)塊引用,那會(huì)看起來像是你自己先斷好行宋雏,然后在每行的最前面加上 >
:
> 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 也允許你偷懶只在整個(gè)段落的第一行最前面加上 >
:
> 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ū)塊等:
> ## 這是一個(gè)標(biāo)題笼沥。
>
> 1\. 這是第一行列表項(xiàng)蚪燕。
> 2\. 這是第二行列表項(xiàng)。
>
> 給出一些例子代碼:
>
> return shell_exec("echo $input | $markdown_script");
任何像樣的文本編輯器都能輕松地建立 email 型的引用奔浅。例如在 BBEdit 中馆纳,你可以選取文字后然后從選單中選擇增加引用階層。
列表
Markdown 支持有序列表和無序列表汹桦。
無序列表使用星號(hào)鲁驶、加號(hào)或是減號(hào)作為列表標(biāo)記:
* Red
* Green
* Blue
等同于:
+ Red
+ Green
+ Blue
也等同于:
- Red
- Green
- Blue
有序列表則使用數(shù)字接著一個(gè)英文句點(diǎn):
1\. Bird
2\. McHale
3\. Parish
很重要的一點(diǎn)是,你在列表標(biāo)記上使用的數(shù)字并不會(huì)影響輸出的 HTML 結(jié)果舞骆,上面的列表所產(chǎn)生的 HTML 標(biāo)記為:
<ol>
<li>Bird</li>
<li>McHale</li>
<li>Parish</li>
</ol>
如果你的列表標(biāo)記寫成:
1\. Bird
1\. McHale
1\. Parish
或甚至是:
3\. Bird
1\. McHale
8\. Parish
你都會(huì)得到完全相同的 HTML 輸出钥弯。重點(diǎn)在于,你可以讓 Markdown 文件的列表數(shù)字和輸出的結(jié)果相同督禽,或是你懶一點(diǎn)脆霎,你可以完全不用在意數(shù)字的正確性。
如果你使用懶惰的寫法狈惫,建議第一個(gè)項(xiàng)目最好還是從 1. 開始睛蛛,因?yàn)?Markdown 未來可能會(huì)支持有序列表的 start 屬性。
列表項(xiàng)目標(biāo)記通常是放在最左邊,但是其實(shí)也可以縮進(jìn)忆肾,最多 3 個(gè)空格菠红,項(xiàng)目標(biāo)記后面則一定要接著至少一個(gè)空格或制表符。
要讓列表看起來更漂亮难菌,你可以把內(nèi)容用固定的縮進(jìn)整理好:
* 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.
如果列表項(xiàng)目間用空行分開,在輸出 HTML 時(shí) Markdown 就會(huì)將項(xiàng)目內(nèi)容用 <p>
標(biāo)簽包起來郊酒,舉例來說:
* Bird
* Magic
會(huì)被轉(zhuǎn)換為:
<ul>
<li>Bird</li>
<li>Magic</li>
</ul>
但是這個(gè):
* Bird
* Magic
會(huì)被轉(zhuǎn)換為:
<ul>
<li><p>Bird</p></li>
<li><p>Magic</p></li>
</ul>
列表項(xiàng)目可以包含多個(gè)段落遇绞,每個(gè)項(xiàng)目下的段落都必須縮進(jìn) 4 個(gè)空格或是 1 個(gè)制表符:
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.
如果你每行都有縮進(jìn),看起來會(huì)看好很多燎窘,當(dāng)然摹闽,再次地,如果你很懶惰褐健,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.
如果要在列表項(xiàng)目內(nèi)放進(jìn)引用付鹿,那 >
就需要縮進(jìn):
* A list item with a blockquote:
> This is a blockquote
> inside a list item.
如果要放代碼區(qū)塊的話,該區(qū)塊就需要縮進(jìn)兩次蚜迅,也就是 8 個(gè)空格或是 2 個(gè)制表符:
* 一列表項(xiàng)包含一個(gè)列表區(qū)塊:
<代碼寫在這>
當(dāng)然舵匾,項(xiàng)目列表很可能會(huì)不小心產(chǎn)生,像是下面這樣的寫法:
1986\. What a great season.
換句話說谁不,也就是在行首出現(xiàn)數(shù)字-句點(diǎn)-空白坐梯,要避免這樣的狀況,你可以在句點(diǎn)前面加上反斜杠刹帕。
1986\. What a great season.
代碼區(qū)塊
和程序相關(guān)的寫作或是標(biāo)簽語言原始碼通常會(huì)有已經(jīng)排版好的代碼區(qū)塊吵血,通常這些區(qū)塊我們并不希望它以一般段落文件的方式去排版,而是照原來的樣子顯示偷溺,Markdown 會(huì)用 <pre>
和 <code>
標(biāo)簽來把代碼區(qū)塊包起來蹋辅。
要在 Markdown 中建立代碼區(qū)塊很簡(jiǎn)單,只要簡(jiǎn)單地縮進(jìn) 4 個(gè)空格或是 1 個(gè)制表符就可以挫掏,例如侦另,下面的輸入:
這是一個(gè)普通段落:
這是一個(gè)代碼區(qū)塊。
Markdown 會(huì)轉(zhuǎn)換成:
<p>這是一個(gè)普通段落:</p>
<pre><code>這是一個(gè)代碼區(qū)塊砍濒。
</code></pre>
這個(gè)每行一階的縮進(jìn)(4 個(gè)空格或是 1 個(gè)制表符)淋肾,都會(huì)被移除,例如:
Here is an example of AppleScript:
tell application "Foo"
beep
end tell
會(huì)被轉(zhuǎn)換為:
<p>Here is an example of AppleScript:</p>
<pre><code>tell application "Foo"
beep
end tell
</code></pre>
一個(gè)代碼區(qū)塊會(huì)一直持續(xù)到?jīng)]有縮進(jìn)的那一行(或是文件結(jié)尾)爸邢。
在代碼區(qū)塊里面樊卓, & 、 < 和 > 會(huì)自動(dòng)轉(zhuǎn)成 HTML 實(shí)體杠河,這樣的方式讓你非常容易使用 Markdown 插入范例用的 HTML 原始碼碌尔,只需要復(fù)制貼上浇辜,再加上縮進(jìn)就可以了,剩下的 Markdown 都會(huì)幫你處理唾戚,例如:
<div class="footer">
© 2004 Foo Corporation
</div>
會(huì)被轉(zhuǎn)換為:
<pre><code><div class="footer">
&copy; 2004 Foo Corporation
</div>
</code></pre>
代碼區(qū)塊中柳洋,一般的 Markdown 語法不會(huì)被轉(zhuǎn)換,像是星號(hào)便只是星號(hào)叹坦,這表示你可以很容易地以 Markdown 語法撰寫 Markdown 語法相關(guān)的文件熊镣。
分隔線
你可以在一行中用三個(gè)以上的星號(hào)、減號(hào)募书、底線來建立一個(gè)分隔線绪囱,行內(nèi)不能有其他東西。你也可以在星號(hào)或是減號(hào)中間插入空格莹捡。下面每種寫法都可以建立分隔線:
* * *
***
*****
- - -
---------------------------------------
區(qū)段元素
鏈接
Markdown 支持兩種形式的鏈接語法: 行內(nèi)式和參考式兩種形式鬼吵。
不管是哪一種,鏈接文字都是用 [方括號(hào)] 來標(biāo)記篮赢。
要建立一個(gè)行內(nèi)式的鏈接齿椅,只要在方塊括號(hào)后面緊接著圓括號(hào)并插入網(wǎng)址鏈接即可,如果你還想要加上鏈接的 title 文字启泣,只要在網(wǎng)址后面涣脚,用雙引號(hào)把 title 文字包起來即可,例如:
This is [an example](http://example.com/ "Title") inline link.
[This link](http://example.net/) has no title attribute.
會(huì)產(chǎn)生:
<p>This is <a title="Title">
an example</a> inline link.</p>
<p><a >This link</a> has no
title attribute.</p>
如果你是要鏈接到同樣主機(jī)的資源种远,你可以使用相對(duì)路徑:
See my [About](/about/) page for details.
參考式的鏈接是在鏈接文字的括號(hào)后面再接上另一個(gè)方括號(hào)涩澡,而在第二個(gè)方括號(hào)里面要填入用以辨識(shí)鏈接的標(biāo)記:
This is [an example][id] reference-style link.
你也可以選擇性地在兩個(gè)方括號(hào)中間加上一個(gè)空格:
This is [an example] [id] reference-style link.
接著,在文件的任意處坠敷,你可以把這個(gè)標(biāo)記的鏈接內(nèi)容定義出來:
[id]: http://example.com/ "Optional Title Here"
鏈接內(nèi)容定義的形式為:
- 方括號(hào)(前面可以選擇性地加上至多三個(gè)空格來縮進(jìn)),里面輸入鏈接文字
- 接著一個(gè)冒號(hào)
- 接著一個(gè)以上的空格或制表符
- 接著鏈接的網(wǎng)址
- 選擇性地接著 title 內(nèi)容射富,可以用單引號(hào)膝迎、雙引號(hào)或是括弧包著
下面這三種鏈接的定義都是相同:
[foo]: http://example.com/ "Optional Title Here"
[foo]: http://example.com/ 'Optional Title Here'
[foo]: http://example.com/ (Optional Title Here)
請(qǐng)注意:有一個(gè)已知的問題是 Markdown.pl 1.0.1 會(huì)忽略單引號(hào)包起來的鏈接 title。
鏈接網(wǎng)址也可以用尖括號(hào)包起來:
[id]: <http://example.com/> "Optional Title Here"
你也可以把 title 屬性放到下一行胰耗,也可以加一些縮進(jìn)限次,若網(wǎng)址太長的話,這樣會(huì)比較好看:
[id]: http://example.com/longish/path/to/resource/here
"Optional Title Here"
網(wǎng)址定義只有在產(chǎn)生鏈接的時(shí)候用到柴灯,并不會(huì)直接出現(xiàn)在文件之中卖漫。
鏈接辨別標(biāo)簽可以有字母、數(shù)字赠群、空白和標(biāo)點(diǎn)符號(hào)羊始,但是并不區(qū)分大小寫,因此下面兩個(gè)鏈接是一樣的:
[link text][a]
[link text][A]
隱式鏈接標(biāo)記功能讓你可以省略指定鏈接標(biāo)記查描,這種情形下突委,鏈接標(biāo)記會(huì)視為等同于鏈接文字柏卤,要用隱式鏈接標(biāo)記只要在鏈接文字后面加上一個(gè)空的方括號(hào),如果你要讓 "Google" 鏈接到 google.com匀油,你可以簡(jiǎn)化成:
[Google][]
然后定義鏈接內(nèi)容:
[Google]: http://google.com/
由于鏈接文字可能包含空白缘缚,所以這種簡(jiǎn)化型的標(biāo)記內(nèi)也許包含多個(gè)單詞:
Visit [Daring Fireball][] for more information.
然后接著定義鏈接:
[Daring Fireball]: http://daringfireball.net/
鏈接的定義可以放在文件中的任何一個(gè)地方,我比較偏好直接放在鏈接出現(xiàn)段落的后面敌蚜,你也可以把它放在文件最后面桥滨,就像是注解一樣。
下面是一個(gè)參考式鏈接的范例:
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"
上面兩種寫法都會(huì)產(chǎn)生下面的 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>
下面是用行內(nèi)式寫的同樣一段內(nèi)容的 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").
參考式的鏈接其實(shí)重點(diǎn)不在于它比較好寫,而是它比較好讀帅韧,比較一下上面的范例里初,使用參考式的文章本身只有 81 個(gè)字符,但是用行內(nèi)形式的卻會(huì)增加到 176 個(gè)字元忽舟,如果是用純 HTML 格式來寫双妨,會(huì)有 234 個(gè)字元,在 HTML 格式中叮阅,標(biāo)簽比文本還要多刁品。
使用 Markdown 的參考式鏈接,可以讓文件更像是瀏覽器最后產(chǎn)生的結(jié)果浩姥,讓你可以把一些標(biāo)記相關(guān)的元數(shù)據(jù)移到段落文字之外挑随,你就可以增加鏈接而不讓文章的閱讀感覺被打斷。
強(qiáng)調(diào)
Markdown 使用星號(hào)(*
)和底線(_
)作為標(biāo)記強(qiáng)調(diào)字詞的符號(hào)勒叠,被 *
或 _
包圍的字詞會(huì)被轉(zhuǎn)成用 <em>
標(biāo)簽包圍兜挨,用兩個(gè) *
或 _
包起來的話,則會(huì)被轉(zhuǎn)成 <strong>
眯分,例如:
*single asterisks*
_single underscores_
**double asterisks**
__double underscores__
會(huì)轉(zhuǎn)成:
<em>single asterisks</em>
<em>single underscores</em>
<strong>double asterisks</strong>
<strong>double underscores</strong>
你可以隨便用你喜歡的樣式拌汇,唯一的限制是,你用什么符號(hào)開啟標(biāo)簽弊决,就要用什么符號(hào)結(jié)束噪舀。
強(qiáng)調(diào)也可以直接插在文字中間:
un*frigging*believable
但是如果你的 *
和 _
兩邊都有空白的話,它們就只會(huì)被當(dāng)成普通的符號(hào)飘诗。
如果要在文字前后直接插入普通的星號(hào)或底線与倡,你可以用反斜線:
\*this text is surrounded by literal asterisks\*
代碼
如果要標(biāo)記一小段行內(nèi)代碼,你可以用反引號(hào)把它包起來(```)昆稿,例如:
Use the `printf()` function.
會(huì)產(chǎn)生:
<p>Use the <code>printf()</code> function.</p>
如果要在代碼區(qū)段內(nèi)插入反引號(hào)纺座,你可以用多個(gè)反引號(hào)來開啟和結(jié)束代碼區(qū)段:
``There is a literal backtick (`) here.``
這段語法會(huì)產(chǎn)生:
<p><code>There is a literal backtick (`) here.</code></p>
代碼區(qū)段的起始和結(jié)束端都可以放入一個(gè)空白,起始端后面一個(gè)貌嫡,結(jié)束端前面一個(gè)比驻,這樣你就可以在區(qū)段的一開始就插入反引號(hào):
A single backtick in a code span: `` ` ``
A backtick-delimited string in a code span: `` `foo` ``
會(huì)產(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)该溯,&
和尖括號(hào)都會(huì)被自動(dòng)地轉(zhuǎn)成 HTML 實(shí)體,這使得插入 HTML 原始碼變得很容易别惦,Markdown 會(huì)把下面這段:
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>&#8212;</code> is the decimal-encoded
equivalent of <code>&mdash;</code>.</p>
圖片
很明顯地狈茉,要在純文字應(yīng)用中設(shè)計(jì)一個(gè)「自然」的語法來插入圖片是有一定難度的。
Markdown 使用一種和鏈接很相似的語法來標(biāo)記圖片掸掸,同樣也允許兩種樣式: 行內(nèi)式和參考式氯庆。
行內(nèi)式的圖片語法看起來像是:
[圖片上傳失敗...(image-3dd485-1536847832372)]
[圖片上傳失敗...(image-c03e2d-1536847832372)]
詳細(xì)敘述如下:
- 一個(gè)驚嘆號(hào)
!
- 接著一個(gè)方括號(hào),里面放上圖片的替代文字
- 接著一個(gè)普通括號(hào)扰付,里面放上圖片的網(wǎng)址堤撵,最后還可以用引號(hào)包住并加上 選擇性的 'title' 文字。
參考式的圖片語法則長得像這樣:
![Alt text][id]
「id」是圖片參考的名稱羽莺,圖片參考的定義方式則和連結(jié)參考一樣:
[id]: url/to/image "Optional title attribute"
到目前為止实昨, Markdown 還沒有辦法指定圖片的寬高,如果你需要的話盐固,你可以使用普通的 <img>
標(biāo)簽荒给。
其它
自動(dòng)鏈接
Markdown 支持以比較簡(jiǎn)短的自動(dòng)鏈接形式來處理網(wǎng)址和電子郵件信箱,只要是用尖括號(hào)包起來刁卜, Markdown 就會(huì)自動(dòng)把它轉(zhuǎn)成鏈接志电。一般網(wǎng)址的鏈接文字就和鏈接地址一樣,例如:
<http://example.com/>
Markdown 會(huì)轉(zhuǎn)為:
<a >http://example.com/</a>
郵址的自動(dòng)鏈接也很類似蛔趴,只是 Markdown 會(huì)先做一個(gè)編碼轉(zhuǎn)換的過程挑辆,把文字字符轉(zhuǎn)成 16 進(jìn)位碼的 HTML 實(shí)體,這樣的格式可以糊弄一些不好的郵址收集機(jī)器人孝情,例如:
<address@example.com>
Markdown 會(huì)轉(zhuǎn)成:
<a href="mailto:addre
ss@example.co
m">address@exa
mple.com</a>
在瀏覽器里面鱼蝉,這段字串(其實(shí)是 <a href="mailto:address@example.com">address@example.com</a>
)會(huì)變成一個(gè)可以點(diǎn)擊的「address@example.com」鏈接。
(這種作法雖然可以糊弄不少的機(jī)器人箫荡,但并不能全部擋下來蚀乔,不過總比什么都不做好些。不管怎樣菲茬,公開你的信箱終究會(huì)引來廣告信件的。)
反斜杠
Markdown 可以利用反斜杠來插入一些在語法中有其它意義的符號(hào)派撕,例如:如果你想要用星號(hào)加在文字旁邊的方式來做出強(qiáng)調(diào)效果(但不用 <em>
標(biāo)簽)婉弹,你可以在星號(hào)的前面加上反斜杠:
\*literal asterisks\*
Markdown 支持以下這些符號(hào)前面加上反斜杠來幫助插入普通的符號(hào):
\ 反斜線
` 反引號(hào)
* 星號(hào)
_ 底線
{} 花括號(hào)
[] 方括號(hào)
() 括弧
# 井字號(hào)
+ 加號(hào)
- 減號(hào)
. 英文句點(diǎn)
! 驚嘆號(hào)
感謝
感謝 leafy7382 協(xié)助翻譯,hlb终吼、Randylien 幫忙潤稿镀赌,ethantw 的漢字標(biāo)準(zhǔn)格式?CSS Reset, WM 回報(bào)文字錯(cuò)誤际跪。