簡述
- Markdown 語法的目標(biāo)是:成為一種適用于網(wǎng)絡(luò)的書寫語言帝嗡。 它的語法種類很少蹦肴,只對應(yīng) HTML 標(biāo)記的一小部分赂摆。它能讓文檔更容易讀、寫和隨意改狸窘。HTML 是一種發(fā)布的格式,Markdown 是一種書寫的格式坯认。
- Markdown 的格式語法只涵蓋純文本可以涵蓋的范圍翻擒。不在 Markdown 涵蓋范圍之內(nèi)的標(biāo)簽,都可以直接在文檔里面用 HTML 撰寫牛哺。不需要額外標(biāo)注這是 HTML 或是 Markdown陋气;只要直接加標(biāo)簽就可以了。要制約的只有一些HTML 區(qū)塊元素――比如 div引润、table巩趁、p和pre 等標(biāo)簽,必須在前后加上空行與其它內(nèi)容區(qū)隔開淳附,還要求它們的開始標(biāo)簽與結(jié)尾標(biāo)簽不能用制表符或空格來縮進(jìn)议慰。
- Markdown 語法在 HTML 區(qū)塊標(biāo)簽間使用無效果,而在 HTML 區(qū)段標(biāo)簽間是有效的奴曙。
目錄
- 簡述
- 特殊字符自動轉(zhuǎn)換
- 區(qū)塊元素
- 段落和換行
- 標(biāo)題
- 區(qū)塊引用
- 列表
- 代碼區(qū)塊
- 分割線
- 區(qū)段元素
- 鏈接
- 強(qiáng)調(diào)
- 代碼
- 圖片
- 其他
- 反斜杠
- 自動鏈接
Markdown 語法說明(簡體中文)詳見:http://wowubuntu.com/markdown/#hr
特殊字符自動轉(zhuǎn)換
- 在 HTML 文件中别凹,有兩個字符需要特殊處理: <和 &。 <符號用于起始簽洽糟,&符號則用于標(biāo)記 HTML 實(shí)體炉菲,如果你只是想要顯示這些字符的原型堕战,你必須要使用實(shí)體的形式,像是 < ;和 & ;拍霜。而網(wǎng)址中的 &字符也要轉(zhuǎn)換嘱丢,才能放到鏈接標(biāo)簽的 href屬性里。
- Markdown 讓你可以自然地書寫字符祠饺,需要轉(zhuǎn)換的由它來處理好了越驻。如果你使用的 &字符是 HTML 字符實(shí)體的一部分,它會保留原狀吠裆,否則它會被轉(zhuǎn)換成&伐谈。比如要在文檔中插入一個版權(quán)符號 ?,可以這樣寫:?copy 试疙,Markdown 會保留它不動诵棵。而若你寫:AT&T,Markdown 就會將它轉(zhuǎn)為:AT& ;T
- 類似祝旷,如果你是把 <符號作為 HTML 標(biāo)簽的定界符使用履澳,那 Markdown 也不會對它做任何轉(zhuǎn)換,但是如果你寫:4 < 5怀跛,Markdown 將會把它轉(zhuǎn)換為:4 < ; 5
- 不過需要注意的是距贷,code 范圍內(nèi),不論是行內(nèi)還是區(qū)塊吻谋, <和 &兩個符號都一定會被轉(zhuǎn)換成 HTML 實(shí)體忠蝗,這項(xiàng)特性讓你可以很容易地用 Markdown 寫 HTML code 。
區(qū)塊元素
段落和換行
一個 Markdown 段落的前后要有一個以上的空行漓拾。普通段落 不該用空格或制表符來縮進(jìn)阁最。
如果你*確實(shí)*想要依賴 Markdown 來插入<br />標(biāo)簽的話,在插入處先按入兩個以上的空格然后回車骇两。
標(biāo)題
Markdown 支持兩種標(biāo)題的語法速种,類Setext]和類atx形式。
類 Setext 形式是用底線的形式低千,利用=(最高階標(biāo)題)和-(第二階標(biāo)題)配阵,任何數(shù)量的=和-都可以
有效果。
類 Atx 形式則是在行首插入 1 到 6 個#示血,對應(yīng)到標(biāo)題 1 到 6 階棋傍。
區(qū)塊引用 Blockquotes
在 Markdown 文件中建立一個區(qū)塊引用,只需在每行的最前面加上>
區(qū)塊引用可以嵌套(例如:引用內(nèi)的引用)难审,只要根據(jù)層次加上不同數(shù)量的>
引用的區(qū)塊內(nèi)也可以使用其他的 Markdown 語法舍沙,包括標(biāo)題、列表剔宪、代碼區(qū)塊等拂铡。
列表
Markdown 支持有序列表和無序列表壹无。
無序列表使用星號、加號或是減號作為列表標(biāo)記感帅。
有序列表則使用數(shù)字接著一個英文句點(diǎn)斗锭。
1.列表項(xiàng)目標(biāo)記通常是放在最左邊,但是其實(shí)也可以縮進(jìn)失球,最多 3 個空格岖是,項(xiàng)目標(biāo)記后面則一定要
接著至少一個空格或制表符。
2.列表項(xiàng)目可以包含多個段落实苞,每個項(xiàng)目下的段落都必須縮進(jìn) 4 個空格或是 1 個制表符豺撑。
3.如果要在列表項(xiàng)目內(nèi)放進(jìn)引用,那>就需要縮進(jìn)黔牵。
4.如果要放代碼區(qū)塊的話聪轿,該區(qū)塊就需要縮進(jìn)兩次,也就是 8 個空格或是 2 個制表符猾浦。
5. 在行首出現(xiàn)數(shù)字-句點(diǎn)-空白陆错,項(xiàng)目列表很可能會不小心產(chǎn)生,像是下面這樣的寫法:
1986. What a great season.
要避免這樣的狀況金赦,可以在句點(diǎn)前面加上反斜杠音瓷。1986\. What a great season.
代碼區(qū)塊
在 Markdown 中建立代碼區(qū)塊很簡單,只要簡單地縮進(jìn) 4 個空格或是 1 個制表符就可以夹抗。
一個代碼區(qū)塊會一直持續(xù)到?jīng)]有縮進(jìn)的那一行(或是文件結(jié)尾)绳慎。
代碼區(qū)塊中,&漠烧、<和>會自動轉(zhuǎn)成 HTML 實(shí)體杏愤,只需要復(fù)制貼上,再加上縮進(jìn)就可以了沽甥,
剩下的 Markdown 都會幫你處理。
代碼區(qū)塊中乏奥,一般的 Markdown 語法不會被轉(zhuǎn)換摆舟,像是星號便只是星號,這表示你可以很容易地以
Markdown 語法撰寫 Markdown 語法相關(guān)的文件邓了。
分隔線
可以在一行中用三個以上的星號恨诱、減號、底線來建立一個分隔線骗炉,行內(nèi)不能有其他東西照宝。你也可以在
星號或是減號中間插入空格。下面每種寫法都可以建立分隔線:
* *
*********
- - -
---------------------------------------
區(qū)段元素
鏈接
- Markdown 支持兩種形式的鏈接語法: 行內(nèi)式和參考式兩種形式句葵。不管是哪一種厕鹃,鏈接文字都是用 [方括號] 來標(biāo)記兢仰。
- 要建立一個行內(nèi)式的鏈接,只要在方塊括號后面緊接著圓括號并插入網(wǎng)址鏈接即可剂碴,如果你還想要加上鏈接的 title 文字把将,只要在網(wǎng)址后面,用雙引號把 title 文字包起來即可忆矛。如果你是要鏈接到同樣主機(jī)的資源察蹲,你可以使用相對路徑。如:
This is an exampleinline link.
See my About page for details.
詳見源代碼催训。 -
參考式的鏈接是在鏈接文字的括號后面再接上另一個方括號洽议,而在第二個方括號里面要填入用以辨識鏈接的標(biāo)記(鏈接辨別標(biāo)簽可以有字母、數(shù)字漫拭、空白和標(biāo)點(diǎn)符號亚兄,但是并不區(qū)分大小寫),也可以選擇性地在兩個方括號中間加上一個空格嫂侍,接著儿捧,在文件的任意處,你可以把這個標(biāo)記的鏈接內(nèi)容定義出來挑宠。如:
This is an example reference-style link.
This is an example reference-style link.
id: http://example.com/ "Optional Title Here"
鏈接內(nèi)容定義的形式為:
1.方括號(前面可以選擇性地加上至多三個空格來縮進(jìn))里面輸入鏈接文字
2.接著一個冒號
3.接著一個以上的空格或制表符
4.接著鏈接的網(wǎng)址
5.選擇性地接著 title 內(nèi)容菲盾,可以用單引號、雙引號或是括弧包著
下面這三種鏈接的定義都是相同:
1.[foo]: http://example.com/ "Optional Title Here"
2.[foo]: http://example.com/ 'Optional Title Here'
3.[foo]: http://example.com/ (Optional Title Here)
鏈接網(wǎng)址也可以用尖括號包起來,如:
也可以把 title 屬性放到下一行各淀,也可以加一些縮進(jìn)懒鉴,若網(wǎng)址太長的話,這樣會比較好看:
隱式鏈接標(biāo)記功能讓你可以省略指定鏈接標(biāo)記碎浇,這種情形下临谱,鏈接標(biāo)記會視為等同于鏈接文字,要用隱式鏈接標(biāo)記只要在鏈接文字后面加上一個空的方括號奴璃,如果你要讓 "Google" 鏈接到 google.com悉默,你可以簡化成:
然后定義鏈接內(nèi)容:
下面是一個參考式鏈接的范例:
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"
強(qiáng)調(diào)
- Markdown 使用星號(*)和底線(_)作為標(biāo)記強(qiáng)調(diào)字詞的符號,被\ *或 _包圍的字詞會被轉(zhuǎn)成用 < em >標(biāo)簽包圍苟穆,用兩個\ *或_包起來的話抄课,則會被轉(zhuǎn)成 < strong > 。
- 但是如果你的 *和 _ 兩邊都有空白的話雳旅,它們就只會被當(dāng)成普通的符號跟磨。
- 如果要在文字前后直接插入普通的星號或底線,你可以用反斜線:
\ *this text is surrounded by literal asterisks\ *
代碼
-
如果要標(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 實(shí)體墩瞳。
—
is the decimal-encoded equivalent of—
.
Please don't use any<blink>
tags.
圖片
Markdown 允許兩種樣式來標(biāo)記圖片:行內(nèi)式和參考式驼壶。
-
行內(nèi)式的圖片語法看起來像是:
詳細(xì)敘述如下:
1.一個驚嘆號 !
2.接著一個方括號,里面放上圖片的替代文字
3.接著一個普通括號喉酌,里面放上圖片的網(wǎng)址热凹,最后還可以用引號包住并加上 選擇性的 'title' 文字。 -
參考式的圖片語法則長得像這樣:
「id」是圖片參考的名稱泪电,圖片參考的定義方式則和連結(jié)參考一樣:
到目前為止般妙, Markdown 還沒有辦法指定圖片的寬高,如果你需要的話相速,你可以使用普通的 < img >標(biāo)簽碟渺。
其他
自動鏈接
- Markdown 支持以比較簡短的自動鏈接形式來處理網(wǎng)址和電子郵件信箱,只要是用尖括號包起來突诬, Markdown 就會自動把它轉(zhuǎn)成鏈接苫拍。
反斜杠
- Markdown 可以利用反斜杠來插入一些在語法中有其它意義的符號。
Markdown 支持以下這些符號前面加上反斜杠來幫助插入普通的符號:\ 反斜線
* 星號
_ 底線
{} 花括號
[] 方括號
() 括弧
# 井字號
\ + 加號
\ - 減號
. 英文句點(diǎn)
! 驚嘆號