Markdown基本語法總結(jié)

前言

初學markdown利朵,看了一些指南篮撑,第一次在簡書上用markdown做的一個總結(jié)屁使,大部分為摘抄與精簡在岂,主要是作為本人markdown的一個練習。
詳情見簡書markdown語法說明蛮寂。

概述

易讀易寫
markdown易讀易寫蔽午,可讀性強,可以直接以純文本形式發(fā)布酬蹋,最大靈感來源于純文本電子郵件格式及老。
可兼容html
注意:在 HTML 區(qū)塊標簽間的 Markdown 格式語法將不會被處理抽莱;而Markdown 語法在 HTML 區(qū)段標簽間是有效的。HTML 的區(qū)段(行內(nèi))標簽如 <span>骄恶、<cite>食铐、<del> 可以在 Markdown 的段落、列表或是標題里隨意使用僧鲁。
特殊字符自由轉(zhuǎn)換
在html中一些字符需要實體化虐呻,而在markdown中可以自由轉(zhuǎn)換。

區(qū)塊元素

段落

一個 Markdown 段落是由一個或多個連續(xù)的文本行組成寞秃,它的前后要有一個以上的空行(空行的定義是顯示上看起來像是空的斟叼,便會被視為空行。比方說春寿,若某一行只包含空格和制表符朗涩,則該行也會被視為空行)。普通段落不該用空格或制表符來縮進堂淡。

標題

markdown支持兩種標題的語法,類 Setext 和類 atx 形式扒腕。
類Setext指增加底線的形式绢淀,利用 =(最高階標題)和- (第二階標題),例如:

This is h1
=======
This is h2
------------

然而需要注意瘾腰,使用這種方式時皆的,標題前一行不能是段落,如是段落蹋盆,需要空一行费薄。
類atx則是最常用的方法,在行首插入 1 到 6 個 # 栖雾,對應到標題 1 到 6 階楞抡,標題由大到小,例如:

#This is a h1
##This is a h2
###This is a h3
####This is a h4
#####This is a h5
######This is a h6

區(qū)塊引用

Markdown 標記區(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.

也可以偷懶只在每個段落前加上>:

> 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.

嵌套引用在網(wǎng)頁上顯示如下:

This is the first level of quoting.

This is nested blockquote.

Back to the first level.

引用的區(qū)塊內(nèi)也可以使用其他的 Markdown 語法,包括標題账胧、列表竞慢、代碼區(qū)塊等:

> ## 這是一個標題。
> 
> 1.   這是第一行列表項治泥。
> 2.   這是第二行列表項筹煮。
> 
> 給出一些例子代碼:
> 
>     return shell_exec("echo $input | $markdown_script");

任何像樣的文本編輯器都能輕松地建立 email 型的引用。例如在 BBEdit 中居夹,你可以選取文字后然后從選單中選擇增加引用階層败潦。

列表

markdown支持無序列表和有序列表本冲。
無序列表使用星號*、加號+或是減號-作為列表標記,在符號后面需要加上一個空格:

*flowers
*tree
*sun

有序列表則使用數(shù)字接著一個英文句點

1.flowers
2.tree
3.sun

很重要的一點是变屁,你在列表標記上使用的數(shù)字并不會影響輸出的 HTML 結(jié)果眼俊,上面的列表所產(chǎn)生的 HTML 標記為:

<ol>
<li>Bird</li>
<li>McHale</li>
<li>Parish</li>
</ol>

所以數(shù)字是否按123大小排列并不重要。
如果你使用懶惰的寫法粟关,第一個項目要從 1. 開始疮胖,因為 Markdown支持有序列表的 start 屬性。

列表項目標記通常是放在最左邊闷板,但是其實也可以縮進澎灸,最多 3 個空格,項目標記后面則一定要接著至少一個空格或制表符遮晚。

列表項目可以包含多個段落性昭,每個項目下的段落都必須縮進 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.

顯示如下:

  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.

如果你每行都有縮進,看起來會看好很多县遣,當然糜颠,再次地,如果你很懶惰萧求,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.

顯示同上其兴。

如果要在列表項目內(nèi)放進引用,那 > 就需要縮進:

*   A list item with a blockquote:

    > This is a blockquote
    > inside a list item.

顯示如下:

  • A list item with a blockquote:

    This is a blockquote
    inside a list item.

如果要放代碼區(qū)塊的話夸政,該區(qū)塊就需要縮進兩次元旬,也就是 8 個空格或是 2 個制表符

*   一列表項包含一個列表區(qū)塊:

        <代碼寫在這>

顯示如下:

  • 一列表項包含一個列表區(qū)塊:

    <代碼寫在這>
    

當然,項目列表很可能會不小心產(chǎn)生守问,像是下面這樣的寫法:

1986. What a great season.

會產(chǎn)生你并不想要的列表排版:

  1. What a great season.

換句話說匀归,也就是在行首出現(xiàn)數(shù)字-句點-空白,要避免這樣的狀況耗帕,你可以在句點前面加上反斜杠穆端。

1986\. What a great season.

代碼區(qū)塊

和程序相關的寫作或是標簽語言原始碼通常會有已經(jīng)排版好的代碼區(qū)塊,通常這些區(qū)塊我們并不希望它以一般段落文件的方式去排版仿便,而是照原來的樣子顯示徙赢,Markdown 會用 <pre> 和 <code> 標簽來把代碼區(qū)塊包起來。

要在 Markdown 中建立代碼區(qū)塊很簡單探越,只要簡單地縮進 4 個空格或是 1 個制表符就可以狡赐,例如,下面的輸入:

這是一個普通段落:

    這是一個代碼區(qū)塊钦幔。

一個代碼區(qū)塊會一直持續(xù)到?jīng)]有縮進的那一行(或是文件結(jié)尾)枕屉。
代碼區(qū)塊中,一般的 Markdown 語法不會被轉(zhuǎn)換鲤氢,像是星號便只是星號搀擂,這表示你可以很容易地以 Markdown 語法撰寫 Markdown 語法相關的文件西潘。

分割線

你可以在一行中用三個以上的星號、減號哨颂、底線來建立一個分隔線喷市,行內(nèi)不能有其他東西。你也可以在星號或是減號中間插入空格威恼。下面每種寫法都可以建立分隔線:

* * *

***

*****

- - -

---------------------------------------

區(qū)段元素

鏈接

Markdown 支持兩種形式的鏈接語法: 行內(nèi)式和參考式兩種形式品姓。
建立行內(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.

參考式的鏈接是在鏈接文字的括號后面再接上另一個方括號,而在第二個方括號里面要填入用以辨識鏈接的標記:

This is [an example][id] reference-style link.

接著弦牡,在文件的任意處友驮,你可以把這個標記的鏈接內(nèi)容定義出來:

[id]: http://example.com/  "Optional Title Here"

鏈接內(nèi)容定義的形式為:

  • 方括號(前面可以選擇性地加上至多三個空格來縮進),里面輸入鏈接文字
  • 接著一個冒號
  • 接著一個以上的空格或制表符
  • 接著鏈接的網(wǎng)址
  • 選擇性地接著 title 內(nèi)容驾锰,可以用單引號卸留、雙引號或是括弧包著

網(wǎng)址定義只有在產(chǎn)生鏈接的時候用到,并不會直接出現(xiàn)在文件之中稻据。

鏈接辨別標簽可以有字母艾猜、數(shù)字买喧、空白和標點符號捻悯,但是并不區(qū)分大小寫,因此下面兩個鏈接是一樣的:

[link text][a]
[link text][A]

隱式鏈接標記功能讓你可以省略指定鏈接標記淤毛,這種情形下今缚,鏈接標記會視為等同于鏈接文字,要用隱式鏈接標記只要在鏈接文字后面加上一個空的方括號低淡,如果你要讓 "Google" 鏈接到 google.com姓言,你可以簡化成:

[Google][]

然后定義鏈接內(nèi)容:

[Google]: http://google.com/

參考式的鏈接其實重點不在于它比較好寫,而是它比較好讀蔗蹋。使用 Markdown 的參考式鏈接何荚,可以讓文件更像是瀏覽器最后產(chǎn)生的結(jié)果,讓你可以把一些標記相關的元數(shù)據(jù)移到段落文字之外猪杭,你就可以增加鏈接而不讓文章的閱讀感覺被打斷餐塘。

強調(diào)

Markdown 使用星號(*)和底線(_)作為標記強調(diào)字詞的符號,被 * 或 _ 包圍的字詞會被轉(zhuǎn)成用 <em> 標簽包圍皂吮,用兩個 * 或 _ 包起來的話戒傻,則會被轉(zhuǎn)成 <strong>税手,例如:

*single asterisks*

_single underscores_

**double asterisks**

__double underscores__

但是如果你的 * 和 _ 兩邊都有空白的話,它們就只會被當成普通的符號需纳。

代碼

除了上面的代碼引用中提到的方法以外芦倒,還有一種方法,需要引用代碼時不翩,如果引用的語句只有一段兵扬,不分行,可以用 ` 將語句包起來慌盯,如:

`Use the `printf()` function.`

如果引用的語句為多行周霉,可以將```置于這段代碼的首行和末行,用法截圖如下:


image.png

圖片

Markdown 使用一種和鏈接很相似的語法來標記圖片,同樣也允許兩種樣式: 行內(nèi)式和參考式亚皂。

行內(nèi)式的圖片語法看起來像是:

[圖片上傳失敗...(image-ee3062-1523191314447)]

[圖片上傳失敗...(image-6dea3e-1523191314448)]

詳細敘述如下:

  • 一個驚嘆號 !
  • 接著一個方括號俱箱,里面放上圖片的替代文字
  • 接著一個普通括號,里面放上圖片的網(wǎng)址灭必,最后還可以用引號包住并加上 選擇性的 'title' 文字狞谱。
  • 參考式的圖片語法則長得像這樣:
![Alt text][id]

「id」是圖片參考的名稱,圖片參考的定義方式則和鏈接參考一樣:

[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>
郵址的自動鏈接也很類似,例如:

<address@example.com>

反斜杠

Markdown 可以利用反斜杠來插入一些在語法中有其它意義的符號烁试,例如:如果你想要用星號加在文字旁邊的方式來做出強調(diào)效果(但不用 <em> 標簽)雇初,你可以在每個星號的前面加上反斜杠:

\*literal asterisks\*

Markdown 支持以下這些符號前面加上反斜杠來幫助插入普通的符號:

\   反斜線
`   反引號
*   星號
_   底線
{}  花括號
[]  方括號
()  括弧
#   井字號
+   加號
-   減號
.   英文句點
!   驚嘆號
?著作權歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市减响,隨后出現(xiàn)的幾起案子靖诗,更是在濱河造成了極大的恐慌,老刑警劉巖支示,帶你破解...
    沈念sama閱讀 216,496評論 6 501
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件刊橘,死亡現(xiàn)場離奇詭異,居然都是意外死亡颂鸿,警方通過查閱死者的電腦和手機促绵,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,407評論 3 392
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人绞愚,你說我怎么就攤上這事叙甸。” “怎么了位衩?”我有些...
    開封第一講書人閱讀 162,632評論 0 353
  • 文/不壞的土叔 我叫張陵裆蒸,是天一觀的道長。 經(jīng)常有香客問我糖驴,道長僚祷,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 58,180評論 1 292
  • 正文 為了忘掉前任贮缕,我火速辦了婚禮辙谜,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘感昼。我一直安慰自己装哆,他們只是感情好,可當我...
    茶點故事閱讀 67,198評論 6 388
  • 文/花漫 我一把揭開白布定嗓。 她就那樣靜靜地躺著蜕琴,像睡著了一般。 火紅的嫁衣襯著肌膚如雪宵溅。 梳的紋絲不亂的頭發(fā)上凌简,一...
    開封第一講書人閱讀 51,165評論 1 299
  • 那天,我揣著相機與錄音恃逻,去河邊找鬼雏搂。 笑死,一個胖子當著我的面吹牛寇损,可吹牛的內(nèi)容都是我干的凸郑。 我是一名探鬼主播,決...
    沈念sama閱讀 40,052評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼润绵,長吁一口氣:“原來是場噩夢啊……” “哼线椰!你這毒婦竟也來了胞谈?” 一聲冷哼從身側(cè)響起尘盼,我...
    開封第一講書人閱讀 38,910評論 0 274
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎烦绳,沒想到半個月后卿捎,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 45,324評論 1 310
  • 正文 獨居荒郊野嶺守林人離奇死亡径密,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 37,542評論 2 332
  • 正文 我和宋清朗相戀三年午阵,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 39,711評論 1 348
  • 序言:一個原本活蹦亂跳的男人離奇死亡底桂,死狀恐怖植袍,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情籽懦,我是刑警寧澤于个,帶...
    沈念sama閱讀 35,424評論 5 343
  • 正文 年R本政府宣布,位于F島的核電站暮顺,受9級特大地震影響厅篓,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜捶码,卻給世界環(huán)境...
    茶點故事閱讀 41,017評論 3 326
  • 文/蒙蒙 一羽氮、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧惫恼,春花似錦档押、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,668評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至盆繁,卻和暖如春掀淘,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背油昂。 一陣腳步聲響...
    開封第一講書人閱讀 32,823評論 1 269
  • 我被黑心中介騙來泰國打工革娄, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人冕碟。 一個月前我還...
    沈念sama閱讀 47,722評論 2 368
  • 正文 我出身青樓拦惋,卻偏偏與公主長得像,于是被迫代替她去往敵國和親安寺。 傳聞我的和親對象是個殘疾皇子厕妖,可洞房花燭夜當晚...
    茶點故事閱讀 44,611評論 2 353

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