Markdown語(yǔ)法說明

![markdown-logo.png][markdown-logo]
[markdown-logo]: http://upload-images.jianshu.io/upload_images/947566-5c4a6d0c90dee65d.png?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240

Markdown 的目標(biāo)是實(shí)現(xiàn)「易讀易寫」。

行內(nèi)HTML

  • 不在 Markdown 涵蓋范圍之內(nèi)的標(biāo)簽躏筏,可以直接在文檔里面用 HTML 撰寫粘拾。
  • 例外:塊區(qū)元素<div> <table> <pre> <p>茁裙,必須在前后加上空白。且不可用空白來(lái)縮排擎勘。

特殊字符自動(dòng)轉(zhuǎn)換

例如:在 HTML 文檔中霉涨,有兩個(gè)字符需要特殊處理: <&

標(biāo)題:

Markdown 支持兩種標(biāo)題的語(yǔ)法餐茵,[Setext][]和 [atx][] 形式。
[Setext]: http://docutils.sourceforge.net/mirror/setext.html
[atx]: http://www.aaronsw.com/2002/atx/

  • Setext 形式是用底線的形式述吸,利用=(一級(jí)標(biāo)題)和-(二級(jí)標(biāo)題)
  • Atx 形式則是在行首插入 1 到 6 個(gè) #忿族,對(duì)應(yīng)到標(biāo)題 1 到 6

引言:Blockquotes

  • Markdown 文檔中建立一個(gè)區(qū)塊引言,那會(huì)看起來(lái)像是強(qiáng)迫斷行刚梭,然后在每行的最前面加上>
  • 允許只在整個(gè)段落的第一行最前面加上 >
  • 區(qū)塊引言可以有級(jí)別(例如:引言內(nèi)的引言)肠阱,只要根據(jù)級(jí)別加上不同數(shù)量的 >
  • 引言的區(qū)塊內(nèi)也可以使用其他的 Markdown 語(yǔ)法票唆,包括標(biāo)題朴读、列表、程序代碼區(qū)塊等

列表

Markdown 支持有序列表和無(wú)序列表

  • 無(wú)序列表使用星號(hào)*走趋、加號(hào)+或是減號(hào)-作為列表標(biāo)記
  • 有序列表則使用數(shù)字接著一個(gè)英文句點(diǎn)
  • 列表項(xiàng)目可以包含多個(gè)段落衅金,每個(gè)項(xiàng)目下的段落都必須縮排 4 個(gè)空白或是一個(gè) tab

程序代碼區(qū)塊

Markdown 會(huì)用 <pre><code>標(biāo)簽來(lái)把程序代碼區(qū)塊包起來(lái)。

  • 代碼塊:縮排 4個(gè)空白或是 1 個(gè)tab 就可以簿煌;或直接使用<pre></pre>
  • 高亮:使用 <code>`</code> 或直接使用 <code></code>
  • 用 <code></code>包裹一段代碼氮唯,并指定一種語(yǔ)言 <pre>\javascript
    $(document).ready(function () {
    alert('hello world');
    });
    ```
    </pre>

支持的語(yǔ)言:actionscript, apache, bash, clojure, cmake, coffeescript, cpp, cs, css, d, delphi, django, erlang, go, haskell, html, http, ini, java, javascript, json, lisp, lua, markdown, matlab, nginx, objectivec, perl, php, python, r, ruby, scala, smalltalk, sql, tex, vbscript, xml

分隔線

在一行中用三個(gè)或以上的星號(hào)*、減號(hào)-姨伟、底線_來(lái)建立一個(gè)分隔線惩琉,行內(nèi)不能有其他東西

鏈接

Markdown 支持兩種形式的鏈接語(yǔ)法: 「行內(nèi)」和「參考」兩種形式。

  • 建立一個(gè)行內(nèi)形式的鏈接夺荒,只要在方塊括號(hào)后面馬上接著括號(hào)并插入網(wǎng)址鏈接即可瞒渠。
  • 參考形式的鏈接使用另外一個(gè)方括號(hào)接在鏈接文字的括號(hào)后面,而在第二個(gè)方括號(hào)里面要填入用以辨識(shí)鏈接的標(biāo)簽技扼;接著伍玖,在文檔的任意處,可以把這個(gè)標(biāo)簽的鏈接內(nèi)容定義出來(lái)剿吻。

強(qiáng)調(diào)

Markdown 使用星號(hào)*和底線_作為標(biāo)記強(qiáng)調(diào)字詞的符號(hào)窍箍。

  • *_包圍的字詞會(huì)被轉(zhuǎn)成用 <em>標(biāo)簽包圍。
  • 用兩個(gè) *_包起來(lái)的話,則會(huì)被轉(zhuǎn)成<strong>椰棘。
  • 如果*_兩邊都有空白的話纺棺,它們就只會(huì)被當(dāng)成普通的符號(hào)。
  • 如果要在文字前后直接插入普通的星號(hào)或底線邪狞,可以用反斜杠

程序代碼

如果要標(biāo)記一小段行內(nèi)程序代碼五辽,可以用反引號(hào)<code>`</code>把它包起來(lái)

圖片

Markdown 使用一種和鏈接很相似的語(yǔ)法來(lái)標(biāo)記圖片,同樣也允許兩種樣式: 「行內(nèi)」和「參考」外恕。

  • 行內(nèi)語(yǔ)法:


    Alt text
    Alt text

    Alt text
    Alt text
  • 參考語(yǔ)法:
    ![Alt text][id]

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

自動(dòng)鏈接

Markdown 支持比較簡(jiǎn)短的自動(dòng)鏈接形式來(lái)處理網(wǎng)址和電子郵件信箱,例如:

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

轉(zhuǎn)義字符

Markdown 可以利用<code></code>反斜杠來(lái)插入一些在語(yǔ)法中有其它意義的符號(hào)鳞疲。

支持在下面這些符號(hào)前面加上反斜杠來(lái)幫助插入普通的符號(hào):
<pre>
\ 反斜杠
` 反引號(hào)
* 星號(hào)
_ 底線
{} 大括號(hào)
[] 方括號(hào)
() 括號(hào)
# 井字號(hào)
+ 加號(hào)
- 減號(hào)
. 英文句點(diǎn)
! 驚嘆號(hào)
</pre>

參考文檔

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末罪郊,一起剝皮案震驚了整個(gè)濱河市,隨后出現(xiàn)的幾起案子尚洽,更是在濱河造成了極大的恐慌悔橄,老刑警劉巖,帶你破解...
    沈念sama閱讀 206,126評(píng)論 6 481
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件腺毫,死亡現(xiàn)場(chǎng)離奇詭異癣疟,居然都是意外死亡,警方通過查閱死者的電腦和手機(jī)潮酒,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 88,254評(píng)論 2 382
  • 文/潘曉璐 我一進(jìn)店門睛挚,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái),“玉大人急黎,你說我怎么就攤上這事扎狱。” “怎么了勃教?”我有些...
    開封第一講書人閱讀 152,445評(píng)論 0 341
  • 文/不壞的土叔 我叫張陵淤击,是天一觀的道長(zhǎng)。 經(jīng)常有香客問我故源,道長(zhǎng)污抬,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 55,185評(píng)論 1 278
  • 正文 為了忘掉前任绳军,我火速辦了婚禮印机,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘删铃。我一直安慰自己耳贬,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 64,178評(píng)論 5 371
  • 文/花漫 我一把揭開白布猎唁。 她就那樣靜靜地躺著咒劲,像睡著了一般顷蟆。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上腐魂,一...
    開封第一講書人閱讀 48,970評(píng)論 1 284
  • 那天帐偎,我揣著相機(jī)與錄音,去河邊找鬼蛔屹。 笑死削樊,一個(gè)胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的兔毒。 我是一名探鬼主播漫贞,決...
    沈念sama閱讀 38,276評(píng)論 3 399
  • 文/蒼蘭香墨 我猛地睜開眼,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼育叁!你這毒婦竟也來(lái)了迅脐?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 36,927評(píng)論 0 259
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤豪嗽,失蹤者是張志新(化名)和其女友劉穎谴蔑,沒想到半個(gè)月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體龟梦,經(jīng)...
    沈念sama閱讀 43,400評(píng)論 1 300
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡隐锭,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 35,883評(píng)論 2 323
  • 正文 我和宋清朗相戀三年,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了计贰。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片钦睡。...
    茶點(diǎn)故事閱讀 37,997評(píng)論 1 333
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡,死狀恐怖蹦玫,靈堂內(nèi)的尸體忽然破棺而出赎婚,到底是詐尸還是另有隱情,我是刑警寧澤樱溉,帶...
    沈念sama閱讀 33,646評(píng)論 4 322
  • 正文 年R本政府宣布,位于F島的核電站纬凤,受9級(jí)特大地震影響福贞,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜停士,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 39,213評(píng)論 3 307
  • 文/蒙蒙 一挖帘、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧恋技,春花似錦拇舀、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,204評(píng)論 0 19
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)。三九已至,卻和暖如春要拂,著一層夾襖步出監(jiān)牢的瞬間抠璃,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 31,423評(píng)論 1 260
  • 我被黑心中介騙來(lái)泰國(guó)打工脱惰, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留搏嗡,地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 45,423評(píng)論 2 352
  • 正文 我出身青樓拉一,卻偏偏與公主長(zhǎng)得像采盒,于是被迫代替她去往敵國(guó)和親。 傳聞我的和親對(duì)象是個(gè)殘疾皇子蔚润,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 42,722評(píng)論 2 345

推薦閱讀更多精彩內(nèi)容