簡(jiǎn)書(shū)Markdown語(yǔ)法 - 小記

這段時(shí)間看簡(jiǎn)書(shū)文章吗浩,自己也開(kāi)始做筆記,記錄自己的一些學(xué)習(xí)內(nèi)容来累。剛開(kāi)始也沒(méi)多在意排版砚作,就隨便排版寫(xiě),寫(xiě)完一兩篇文章嘹锁,當(dāng)自己以游客的角度去看自己寫(xiě)的文章時(shí)葫录,才發(fā)現(xiàn)自己文章的排版是那么不堪入目。于是我就開(kāi)始查找原因领猾。在簡(jiǎn)書(shū)上找到了自己目前比較滿(mǎn)意的一篇文章米同。
此文章內(nèi)容是轉(zhuǎn)自:簡(jiǎn)書(shū) Markdown 語(yǔ)法詳解
還有一篇文章值得推薦看:Markdown 語(yǔ)法整理大集合2017

關(guān)于簡(jiǎn)書(shū) Markdown

Markdown 語(yǔ)法的目標(biāo): 成為一種適用于網(wǎng)絡(luò)的書(shū)寫(xiě)語(yǔ)言。
本文的目的:使讀者輕松了解簡(jiǎn)書(shū)對(duì) Markdown 語(yǔ)法的支持瘤运,了解其優(yōu)點(diǎn)和不足窍霞。能夠在選擇時(shí)正確取舍,使用時(shí)得心應(yīng)手拯坟。


一但金、區(qū)塊標(biāo)記

區(qū)塊標(biāo)記:是指內(nèi)容獨(dú)占一塊,需前后換行郁季,不和其他標(biāo)記共處一行的標(biāo)記冷溃。

1. 段落

段落:即是一段連續(xù)的文字钱磅,可包含*、空格似枕、換行盖淡、tab等字符。兩個(gè)段落之間使用空行分隔凿歼。

示例代碼

第一自然段

第二自然段

效果

第一自然段

第二自然段

注意:換行不是分段的標(biāo)識(shí)褪迟,空行才是

2. 標(biāo)題

標(biāo)題:代表了文章中主題的層次,比如:文章標(biāo)題使用一級(jí)標(biāo)題答憔,回目名稱(chēng)使用二級(jí)標(biāo)題味赃,小節(jié)使用三級(jí)標(biāo)題,依次類(lèi)推虐拓。主題的層次代表了文章的大綱心俗。

語(yǔ)法:Markdown 中使用連續(xù)的 n(1-6) 個(gè) # 分別表示第 n 級(jí)標(biāo)題。
示例代碼

    # 一級(jí)標(biāo)題
    ## 二級(jí)標(biāo)題
    ### 三級(jí)標(biāo)題
    #### 四級(jí)標(biāo)題
    ##### 五級(jí)標(biāo)題
    ###### 六級(jí)標(biāo)題

效果

一級(jí)標(biāo)題

二級(jí)標(biāo)題

三級(jí)標(biāo)題

四級(jí)標(biāo)題

五級(jí)標(biāo)題
六級(jí)標(biāo)題

注:# 和后續(xù)內(nèi)容之間應(yīng)放置一個(gè)空格

3. 列表

列表:就是一組相關(guān)信息的集合蓉驹。簡(jiǎn)書(shū)中的列表分為 有序列表無(wú)序列表城榛。

1) 有序列表

語(yǔ)法:使用 數(shù)字 + . 作為項(xiàng)目符號(hào),項(xiàng)目符號(hào)和正式列表項(xiàng)目之間有一個(gè)空格态兴。

示例代碼

1\. 打開(kāi)冰箱門(mén)
2\. 把大象放進(jìn)冰箱
3\. 關(guān)上冰箱門(mén)

效果

  1. 打開(kāi)冰箱門(mén)
  2. 把大象放進(jìn)冰箱
  3. 關(guān)上冰箱門(mén)

2) 無(wú)序列表

語(yǔ)法:使用 * 作為項(xiàng)目符號(hào)狠持,項(xiàng)目符號(hào)和正式列表項(xiàng)目之間有一個(gè)空格。

示例代碼

* 吃飯
* 睡覺(jué)
* 打豆豆

效果

  • 吃飯
  • 睡覺(jué)
  • 打豆豆

注意事項(xiàng)

  • *無(wú)序列表的項(xiàng)目符號(hào)可使用 ,+,- 效果是相同的诗茎。
  • 列表與后續(xù)內(nèi)容之間需要一個(gè)空行隔開(kāi)工坊,即:列表是一個(gè)段落
  • 列表允許多層次嵌套
  • 可以在項(xiàng)目中包含段落,只需將段落前添加一個(gè) tab 或 4 個(gè)空格

4. 分割線

語(yǔ)法:使用 3 個(gè)連續(xù)的 * 即可得到一個(gè)分割線

示例代碼

***

效果


5. 引用

語(yǔ)法:在行頭加上 > 即可敢订。

這里是一段引用

注意事項(xiàng):

  • 大于號(hào) 和 文字必須有一個(gè)空格
  • 可以在每行之前加 > 王污,也可以在段落之前加 1 個(gè) >
  • 引用內(nèi)部可以使用其他 Markdown 標(biāo)記

引用內(nèi)部可以添加新的引用,只需再加一個(gè)大于號(hào)


二楚午、行內(nèi)標(biāo)記

行內(nèi)標(biāo)記和其他標(biāo)記共處一行昭齐。

1. 強(qiáng)調(diào)文字

1) 斜體

語(yǔ)法:使用前后各 1 個(gè) *(或_) 包含的文字是 斜體 文字
示例代碼

*斜體*, _斜體_

效果

斜體, 斜體

2) 粗體

語(yǔ)法:使用前后各 2 個(gè) *(或_) 包含的文字是 粗體 文字
示例代碼

**粗體**,__粗體__

效果

粗體矾柜,粗體

3) 刪除文字

語(yǔ)法:使用前后各 2 個(gè) ~ 包含的文字是刪除文字
示例代碼

~~刪除~~

效果

刪除

4) 粗斜體

語(yǔ)法:(或_)中嵌套 (或) 或 在_(或)中嵌套**(或__)即可得到 粗斜體阱驾。

示例代碼

_**粗斜體**_, *__粗斜體__*
**_粗斜體_**怪蔑, __*粗斜體*__

效果

粗斜體里覆, 粗斜體
粗斜體粗斜體

2. 圖片與鏈接

1) 圖片:行內(nèi)圖片缆瓣、引用圖片

1> 行內(nèi)圖片
圖片和圖片地址寫(xiě)在一起喧枷。
語(yǔ)法: [圖片上傳失敗...(image-47a801-1518246319069)]
示例代碼

![史努比](http://upload-images.jianshu.io/upload_images/2779565-13b3439b110c16bf.jpeg?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240)

效果

史努比

注意事項(xiàng)

在簡(jiǎn)書(shū)中,圖片可以直接拖到編輯區(qū),會(huì)自動(dòng)上傳圖片并生成圖片地址隧甚。本功能是簡(jiǎn)書(shū)提供的一大便利车荔,值得表?yè)P(yáng)!

2> 引用圖片
圖片和圖片地址分開(kāi)書(shū)寫(xiě)戚扳。
語(yǔ)法:
![圖片標(biāo)題][圖片id]
[圖片id]:圖片url

示例代碼:

![史努比][snoopy]
[snoopy]: http://upload-images.jianshu.io/upload_images/2779565-13b3439b110c16bf.jpeg?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240

效果

![史努比][snoopy]
[snoopy]: http://upload-images.jianshu.io/upload_images/2779565-13b3439b110c16bf.jpeg?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240
注意事項(xiàng)
引用圖片的 id 在文章中必須唯一

2) 鏈接:行內(nèi)鏈接忧便、鏈接引用、自動(dòng)鏈接

1> 行內(nèi)鏈接
語(yǔ)法:[鏈接名稱(chēng)](鏈接地址 url "鏈接title")
示例代碼

 [新浪](http://www.sina.com.cn "新浪主頁(yè)")

效果

新浪

注意事項(xiàng)

雙引號(hào)中的內(nèi)容是鏈接的 title (目前漢字顯示不正確)

2> 鏈接引用
一種鏈接和地址分離的方式帽借。
語(yǔ)法:
[鏈接名稱(chēng)][鏈接id]
[鏈接id]:鏈接 url 地址 "鏈接 title"

示例代碼

根據(jù) [雅虎][yahoo] 的調(diào)查珠增,希拉里將當(dāng)選;根據(jù) [谷歌][google] 的調(diào)查宜雀,川普將當(dāng)選切平。

[yahoo]: http://search.yahoo.com/ "Yahoo Search"
[google]: http://google.com/ "Google"

效果
根據(jù) 雅虎 的調(diào)查,希拉里將當(dāng)選辐董;根據(jù) 谷歌 的調(diào)查,川普將當(dāng)選禀综。

注意事項(xiàng)

鏈接 id 可使用字母简烘、數(shù)字、空格定枷,但不區(qū)分大小寫(xiě)

3> 自動(dòng)鏈接
一種簡(jiǎn)明的鏈接書(shū)寫(xiě)方式
語(yǔ)法:<鏈接地址>

示例代碼

<http://www.sina.com.cn>

效果

http://www.sina.com.cn

3. 腳注

為名詞提供注釋?zhuān)⑨寣@示在文章末尾孤澎。
語(yǔ)法:
待解釋文字[^腳注 id]
[^腳注 id]:注釋內(nèi)容

示例代碼

Hello程序[^hello]

[^hello]:即:Hello, world 程序

效果
Hello程序[1]

注意事項(xiàng)

  • 腳注 id 必須唯一
  • 無(wú)論腳注 id 如何起名,顯示時(shí)一律標(biāo)為數(shù)字欠窒,并且按出現(xiàn)順序排列

三覆旭、雙標(biāo)記

既可作為區(qū)塊標(biāo)記又可作為行內(nèi)標(biāo)記的標(biāo)記。

1. 代碼塊

1) 行內(nèi)代碼塊

語(yǔ)法:使用兩個(gè) ` 將代碼包含起來(lái)

示例代碼

在 Java 輸出 Hello, world :`System.out.print("Hello, World!");`

效果

在 Java 輸出 Hello, world :System.out.print("Hello, World!");

2) 多行代碼塊

語(yǔ)法:只需要每行都縮進(jìn) 4 個(gè)空格即可岖妄,或者使用```框起來(lái)型将。

示例代碼 1 (行前4個(gè)空格)

// JQuery 的 Hello, world
$(function(){
alert("Hello, world!")
});

效果(行前4個(gè)空格)

// JQuery 的 Hello, world
$(function(){
    alert("Hello, world!")
});

示例代碼 2 (```)

// JQuery 的 Hello, world
$(function(){
alert("Hello, world!")
});

效果 (```)

// JQuery 的 Hello, world
$(function(){
    alert("Hello, world!")
});

注意事項(xiàng):

  1. 在代碼區(qū)塊內(nèi)部,", <>,& 將會(huì)自動(dòng)轉(zhuǎn)換為轉(zhuǎn)義字符
  2. 在代碼區(qū)塊內(nèi)部荐虐,Markdown 標(biāo)記將保持原樣七兜,即:星號(hào)()就是星號(hào)(),不被解釋為特殊標(biāo)記福扬,這樣就可以不能繼續(xù)使用 Markdown 語(yǔ)法了**

四腕铸、表格

語(yǔ)法:

  1. 第一行為表頭,第二行分隔表頭和主體部分铛碑,第三行開(kāi)始每一行為一個(gè)表格行狠裹。
  2. 列于列之間用管道符 | 隔開(kāi)。表格每一行兩邊的管道符可省略汽烦。
  3. 第二行還可以為不同的列指定對(duì)齊方向涛菠。標(biāo)題默認(rèn)為居中對(duì)齊,內(nèi)容默認(rèn)為左對(duì)齊;在 - 左邊加上 : 就是左對(duì)齊碗暗;在 - 右邊加上 : 就是右對(duì)齊膀藐;在 - 兩邊都加上 : 就是居中對(duì)齊抖棘。

示例代碼

姓名|語(yǔ)文成績(jī)|數(shù)學(xué)成績(jī)|總成績(jī)
---|:---|:---:|---:
喜羊羊|100|120|220

效果

姓名 語(yǔ)文成績(jī) 數(shù)學(xué)成績(jī) 總成績(jī)
喜羊羊 100 120 220

五、其他問(wèn)題

1. Markdown 與 HTML 的關(guān)系

  1. HTML 是一種發(fā)布的格式,Markdown 是一種書(shū)寫(xiě)的格式枪萄。
  2. Markdown 的格式語(yǔ)法只涵蓋純文本可以涵蓋的范圍。
  3. 在 Markdown 中可直接使用 HTML 標(biāo)簽其垄,但需要注意
  • 對(duì)于 HTML 區(qū)塊元素――如 div刷钢、table、pre勤篮、p 等標(biāo)簽都毒,必須在前后加上空行與其它內(nèi)容區(qū)隔開(kāi),還要求它們的開(kāi)始標(biāo)簽與結(jié)尾標(biāo)簽不能用制表符(tab)或空格來(lái)縮進(jìn)
  • HTML 的行內(nèi)標(biāo)簽——如 span碰缔、cite账劲、del 可以在 Markdown 的段落、列表或是標(biāo)題里隨意使用金抡。
  • 在 HTML 的區(qū)塊標(biāo)簽中的 Markdown 標(biāo)簽是沒(méi)有效果的

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

  • 在 HTML 文件中瀑焦,有兩個(gè)字符需要特殊處理: < 和 &,必須使用轉(zhuǎn)義字符:& lt ; 和 & amp ;
  • Markdown 中梗肝,你可以自由的書(shū)寫(xiě) < 和 &榛瓮,編輯器會(huì)智能的進(jìn)行判斷:當(dāng)這些符號(hào)用于 HTML 標(biāo)簽中,他們將保留原型巫击;當(dāng)他們單獨(dú)使用時(shí)禀晓,將會(huì)轉(zhuǎn)換為字符實(shí)體。
  • 在代碼塊中坝锰,它們將統(tǒng)統(tǒng)被轉(zhuǎn)換為字符實(shí)體粹懒,即:原樣顯示。

3. Markdown 中的轉(zhuǎn)義字符

Markdown 中什黑,如需顯示有特定意義的符號(hào)崎淳,如:*,# 等,可使用 反斜杠 \ 進(jìn)行轉(zhuǎn)義愕把〖鸢迹可對(duì)如下字符進(jìn)行轉(zhuǎn)義:

*
`
*
_
{}
()
#
+
-
.
!  

六、簡(jiǎn)書(shū)尚不支持的標(biāo)記和不足

  1. 用于生成目錄索引的 [TOC]
  2. 用于說(shuō)明文章標(biāo)簽的 tags
  3. 定義列表和待辦事宜 Todo 列表
  4. 數(shù)學(xué)公式
  5. 各種圖形:流程圖恨豁、時(shí)序圖嚣镜、甘特圖
  6. 其他技術(shù),如:{mermaid}
  7. 區(qū)塊代碼中不顯示行號(hào)

七橘蜜、給簡(jiǎn)書(shū)的一點(diǎn)建議

  1. 對(duì)于普通用戶(hù)來(lái)講菊匿,定義列表付呕、生成目錄索引和文章標(biāo)簽功能是十分必要的,希望能夠盡快增加這些功能跌捆。希望能夠?qū)崿F(xiàn)預(yù)覽圖和編輯器的同步滾動(dòng)功能徽职。
  2. 對(duì)于理工狗來(lái)講,編輯 LaTex 數(shù)學(xué)公式是非常必要的功能佩厚,希望能夠盡快增加這個(gè)功能姆钉。
  3. 對(duì)于代碼狗來(lái)講,區(qū)塊代碼中顯示行號(hào)抄瓦,以及流程圖潮瓶、時(shí)序圖是非常必要的功能,希望能夠盡快增加這些功能钙姊。
  4. 其他的諸如:待辦事宜列表毯辅、甘特圖,mermaid等功能煞额,可以慢慢實(shí)現(xiàn)思恐。

作者:白老師課堂
鏈接:http://www.reibang.com/p/4e3cae082b47
來(lái)源:簡(jiǎn)書(shū)
著作權(quán)歸作者所有。商業(yè)轉(zhuǎn)載請(qǐng)聯(lián)系作者獲得授權(quán)立镶,非商業(yè)轉(zhuǎn)載請(qǐng)注明出處壁袄。

八、補(bǔ)充點(diǎn)

  1. Markdown換行媚媒,使用br標(biāo)簽。
    示例:
    第一段<br>第二段<br><br>第三段<br><br><br>第四段
    
    效果:
    第一段
    第二段

    第三段


    第四段

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末涩僻,一起剝皮案震驚了整個(gè)濱河市缭召,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌逆日,老刑警劉巖嵌巷,帶你破解...
    沈念sama閱讀 206,968評(píng)論 6 482
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場(chǎng)離奇詭異室抽,居然都是意外死亡搪哪,警方通過(guò)查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 88,601評(píng)論 2 382
  • 文/潘曉璐 我一進(jìn)店門(mén)坪圾,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái)晓折,“玉大人,你說(shuō)我怎么就攤上這事兽泄±旄牛” “怎么了?”我有些...
    開(kāi)封第一講書(shū)人閱讀 153,220評(píng)論 0 344
  • 文/不壞的土叔 我叫張陵病梢,是天一觀的道長(zhǎng)胃珍。 經(jīng)常有香客問(wèn)我,道長(zhǎng),這世上最難降的妖魔是什么觅彰? 我笑而不...
    開(kāi)封第一講書(shū)人閱讀 55,416評(píng)論 1 279
  • 正文 為了忘掉前任吩蔑,我火速辦了婚禮,結(jié)果婚禮上填抬,老公的妹妹穿的比我還像新娘烛芬。我一直安慰自己,他們只是感情好痴奏,可當(dāng)我...
    茶點(diǎn)故事閱讀 64,425評(píng)論 5 374
  • 文/花漫 我一把揭開(kāi)白布蛀骇。 她就那樣靜靜地躺著,像睡著了一般读拆。 火紅的嫁衣襯著肌膚如雪擅憔。 梳的紋絲不亂的頭發(fā)上,一...
    開(kāi)封第一講書(shū)人閱讀 49,144評(píng)論 1 285
  • 那天檐晕,我揣著相機(jī)與錄音暑诸,去河邊找鬼。 笑死辟灰,一個(gè)胖子當(dāng)著我的面吹牛个榕,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播芥喇,決...
    沈念sama閱讀 38,432評(píng)論 3 401
  • 文/蒼蘭香墨 我猛地睜開(kāi)眼西采,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼!你這毒婦竟也來(lái)了继控?” 一聲冷哼從身側(cè)響起械馆,我...
    開(kāi)封第一講書(shū)人閱讀 37,088評(píng)論 0 261
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤,失蹤者是張志新(化名)和其女友劉穎武通,沒(méi)想到半個(gè)月后霹崎,有當(dāng)?shù)厝嗽跇?shù)林里發(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 43,586評(píng)論 1 300
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡冶忱,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 36,028評(píng)論 2 325
  • 正文 我和宋清朗相戀三年尾菇,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片囚枪。...
    茶點(diǎn)故事閱讀 38,137評(píng)論 1 334
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡派诬,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出眶拉,到底是詐尸還是另有隱情千埃,我是刑警寧澤,帶...
    沈念sama閱讀 33,783評(píng)論 4 324
  • 正文 年R本政府宣布忆植,位于F島的核電站放可,受9級(jí)特大地震影響谒臼,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜耀里,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 39,343評(píng)論 3 307
  • 文/蒙蒙 一蜈缤、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧冯挎,春花似錦底哥、人聲如沸。這莊子的主人今日做“春日...
    開(kāi)封第一講書(shū)人閱讀 30,333評(píng)論 0 19
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)。三九已至翰守,卻和暖如春孵奶,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背蜡峰。 一陣腳步聲響...
    開(kāi)封第一講書(shū)人閱讀 31,559評(píng)論 1 262
  • 我被黑心中介騙來(lái)泰國(guó)打工了袁, 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人湿颅。 一個(gè)月前我還...
    沈念sama閱讀 45,595評(píng)論 2 355
  • 正文 我出身青樓载绿,卻偏偏與公主長(zhǎng)得像,于是被迫代替她去往敵國(guó)和親油航。 傳聞我的和親對(duì)象是個(gè)殘疾皇子崭庸,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 42,901評(píng)論 2 345

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