Markdown分級語法手冊

[TOC]

PS: 本地預(yù)覽目錄OK典格,但是簡書貌似不支持列敲,暫時先這樣。

前言(可以不看)

最開始只是想寫一篇博文帖汞,準(zhǔn)備使用markdown戴而,感覺很流行(github、簡書……很多都支持)翩蘸,而且渲染出來很好看所意,一直很想學(xué),沒有合適的機(jī)會催首,結(jié)果拖到了現(xiàn)在扶踊。比起什么python、C之類的編程語言郎任,markdown常用的語法也就10個左右秧耗,還是比較容易的,網(wǎng)上資料也很多舶治,看了兩天分井,有了一點初步的認(rèn)識,感覺現(xiàn)在來說基本夠用了霉猛,后面用到一些特殊or高級功能的時候再通過參考鏈接進(jìn)行學(xué)習(xí)和使用就好尺锚。畢竟markdown也只是一種工具、一種表現(xiàn)形式惜浅,私以為不用在上面花費太多精力瘫辩,而且它自己也說了,這是為了讓大家專注于寫作的一種輕量級語言。

下面的參考手冊從語法伐厌、工具兩個方面寫了一些參考(因為別人的博客已經(jīng)寫得很好了承绸,就不用重新貼一遍引用,直接指路鏈接)弧械,主要目的是如果自己忘了八酒,能夠查找起來非常迅速∪刑疲可能對完全沒有接觸過markdown的小白同學(xué)來說不是很友好羞迷,但我在最后列了一下從小白到入門到中級到高級balabala的路線。私以為我現(xiàn)在的學(xué)習(xí)進(jìn)度應(yīng)該是入門和中級之間画饥,當(dāng)前來看衔瓮,已知的這些知識已經(jīng)夠用,我需要一段時間進(jìn)行使用抖甘、鞏固热鞍,后面如果有需要我再繼續(xù)往上。

私以為markdown語法分3級(因為沒有詳細(xì)調(diào)研衔彻,所以可能不太對):最基本的Markdown薇宠,擴(kuò)展的 Markdown Extra,GitHub Flavored Markdown (GFM)(可能GFM就是一種 Markdown Extra)艰额。下面的語法澄港,絕大多數(shù)markdown編輯器都是支持的,但有一些很棒的功能只有支持解析GFM的才能支持柄沮,還有一些只能在GitHub上寫回梧,暫時還沒學(xué)會,所以先記下祖搓,后面用到了再慢慢學(xué)狱意。

好像說了一堆廢話,下面直接開始吧拯欧。

基本語法(18)

  • 純文字(1-3):能夠撰寫文章大綱详囤,展現(xiàn)基本的層級、邏輯關(guān)系哈扮,表達(dá)基本的含義纬纪;
  • + 強(qiáng)調(diào)樣式(4-8):能夠在基本的含義之上,添加一些簡單樣式滑肉,表達(dá)的含義更豐富包各;
  • + 鏈接跳轉(zhuǎn)(9-10):不管文章長度如何,如果有索引跳轉(zhuǎn)機(jī)制靶庙,可以顯著提升讀者閱讀體驗问畅;
  • + 參考引用(11-13):如果就是自己的記錄,可能沒什么參考引用的地方,但只要是寫正式的文章护姆,參考引用肯定是必需的矾端;
  • + 通用多媒體對象(14-15):上面基本都還是純文字,雖然加了一些樣式卵皂、鏈接引用之類秩铆,但表現(xiàn)力、感染力還是弱了一些灯变,在添加一些通用多媒體對象后殴玛,能夠表達(dá)更多的含義,感染力更強(qiáng)添祸;
  • + 特定多媒體對象(16-18):對大部分人來說可能不會用到滚粟,針對特定需求去學(xué)習(xí)使用。

可能有些效果有多種實現(xiàn)形式刃泌,這里只列舉私以為簡單有用的形式(1個或2個)凡壤,如果想要了解更多,去看參考文獻(xiàn)更好耙替。另外亚侠,快捷鍵均為 Sublime Text 插件 MarkdownEditing 編輯器環(huán)境下,后文就不一一說明了俗扇。

1. 標(biāo)題#

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

快捷鍵:

  • Ctrl+1/2/3/4/5/6盖奈,分別插入一級至六級標(biāo)題.

2. 無序列表-

    - 無序列表
    - 無序列表
    - 無序列表

3. 有序列表1.

    1. 有序列表
    2. 有序列表
    3. 有序列表

4. 斜體*

    *斜體*

5. 粗體**

    **粗體**

6. 加粗斜體***

    ***加粗斜體***

7. 刪除線~~

    ~~刪除線~~

8. 分隔線---

    ---

9. 目錄:[TOC]

    [TOC]

10. 錨點{#}

    ## 目錄{#index}
    
    跳轉(zhuǎn)到[目錄](#index)

11. 引用>

    > 一級引用

    >> 二級引用

    >>> 三級引用

根據(jù)tab縮進(jìn)不同,引用可嵌套

12. 注腳[^]

    markdown[^1]狐援, GitHub[^2]

    [^1]: Markdown 是一種純文本標(biāo)記語言
    [^2]: GitHub 是一個代碼托管平臺

13. 鏈接[]( "")

    行內(nèi)式:
    [blog](http://www.cnblogs.com/Chayeen/ "鼠標(biāo)懸停文本")
    參考式1:
    [blog][1]
    [1]:http://www.cnblogs.com/Chayeen/ "鼠標(biāo)懸停文本"
    參考式2:
    [blog][]
    [blog]:http://www.cnblogs.com/Chayeen/ "鼠標(biāo)懸停文本"
    自動鏈接:<>
    <http://www.cnblogs.com/Chayeen/>

快捷鍵:

  • Ctrl+Win+V:選中的內(nèi)容將自動轉(zhuǎn)換為行內(nèi)式超鏈接,鏈接到剪貼板中的內(nèi)容究孕;
  • Ctrl+Win+R:選中的內(nèi)容將自動轉(zhuǎn)換為參考式超鏈接(全文多處引用時)啥酱,鏈接到剪貼板中的內(nèi)容;
  • 輸入 “mdl + tab” :會自動生成鏈接標(biāo)記:[](link)

14. 圖片![]( "")

    行內(nèi)式:
    ![圖片](http://www.example.com/demo.png "demo")
    參考式:
    ![圖片][demo]
    [demo]:http://www.example.com/demo.png "demo"

快捷鍵:

  • Win+Shift+K:插入一個標(biāo)準(zhǔn)的行內(nèi)式圖片(此快捷鍵可能與輸入法有沖突)
  • 輸入 “mdi + tab” :會自動插入下面的圖片標(biāo)記:
    ![Alt text](/path/to/img.jpg "Optional title")

15. 表格|

    | Tables        | Are           | Cool  |
    |:------------- |:-------------:| -----:|
    | col 3 is      | right-aligned | $1600 |
    | col 2 is      | centered      |   $12 |
    | zebra stripes | are neat      |    $1 |

如果覺得表格輸入太過麻煩厨诸,這里有2個參考鏈接能夠簡化一下表格操作:

16. 代碼:`

    `行內(nèi)代碼`
    ```c
    #include <stdio.h>
    int main()
    {
        printf("Hello Jianshu!")
    }
    ```

17. 公式$

    行內(nèi)公式:
    $E=mc^2$
    整行公式:
    $$\sum_{i=1}^n a_i=0$$

公式也不太常用镶殷,更多語法參考: MathJax

18. 流程圖

    flow
    st=>start: Start:>https://www.zybuluo.com
    io=>inputoutput: verification
    op=>operation: Your Operation
    cond=>condition: Yes or No?
    sub=>subroutine: Your Subroutine
    e=>end
    st->io->op->cond
    cond(yes)->e
    cond(no)->sub->io

流程圖測試沒有成功,由于暫時用不到微酬,先不管了史辙。更多語法參考:流程圖語法參考

注意事項

  1. 由于當(dāng)前各種Markdown的編輯器堪滨、解析器很多,可能有些只支持基本的Markdown語法,有些支持Markdown Extra须揣,有些支持 GitHub Flavored Markdown,還有些語法可能需要編輯器進(jìn)行特殊配置才能夠支持姑躲,特別是代碼棠涮、公式、流程圖這種特定多媒體對象,暫時還沒弄清楚绽族,反正基本能用姨涡,后面用到了再說。
  2. 在 Markdown 編寫中私以為最重要的需要理解 空格吧慢、空行涛漂、tab縮進(jìn) 的作用,如果渲染出來的效果不是你想象的那樣检诗,除了明顯的語法問題以外匈仗,很多時候都是沒有用空格、空行岁诉、tab縮進(jìn)進(jìn)行分隔導(dǎo)致的锚沸。私以為記住以下三點原則就能夠hold住大部分問題:
    • 關(guān)鍵字與正文內(nèi)容之間,都采用空格進(jìn)行分隔
    • 一個空行才表示分段涕癣,在要分段的地方哗蜈,一定要空一行;不想分段的地方坠韩,敲個回車就行了
    • tab縮進(jìn)主要表示一種層級關(guān)系距潘,在各種嵌套的時候,一定要注意縮進(jìn)只搁,縮進(jìn)少一個空格都有可能出問題音比,詳情見參考資料Markdown 語法手冊從(完整整理版)
  3. 圖片鏈接引用主要有如下三種方式,分別進(jìn)行討論:
    • 本地圖片:使用絕對 or 相對即可氢惋,但是就是只能自己看洞翩,別人是看不了的
    • 圖片外鏈:直接使用 http 鏈接即可,但如果是自己的圖片焰望,比如說截圖骚亿、照片之類,則需要上傳圖片到圖床之后熊赖,生成一個圖片外鏈進(jìn)行引用来屠。調(diào)研了一番,最后選擇了七牛云+極簡圖床/MPic-圖床神器的方式震鹉,參考這里進(jìn)行注冊俱笛、配置、上傳即可簡單使用了
    • 圖片 base64 :即利用base64 工具把圖片轉(zhuǎn)成一串字符串放在鏈接的位置即可传趾,本來最初想用這種方式迎膜,因為它無需依賴圖床,直接把圖片寫入到了md文件中墨缘,感覺比較獨立星虹,很不錯零抬;結(jié)果后來看到了這個base64的弊端,發(fā)現(xiàn) base64 有一些很硬的缺點宽涌,所以最后還是選擇了外鏈的方式平夜。

參考資料

從小白到入門到中級到高級……本文撰寫很多就參考了這些,都列在了后面卸亮,還有一些后續(xù)可能會用到的進(jìn)階資料忽妒,也整理到后面,給自己定個目標(biāo)兼贸。

  1. 一張圖理解Markdown語法:對應(yīng)關(guān)系很明顯段直,最最基礎(chǔ)的,看完可能就可以開始動手寫了溶诞。
  2. Markdown——入門指南:講解的比較詳細(xì)鸯檬,比上一張圖來說,能夠看出一些效果螺垢。
  3. Markdown基礎(chǔ)語法總結(jié)Markdown 11種基本語法:比上面一個又多了幾個語法喧务,基本能夠hold住大部分情況了。
  4. Markdown語法說明(簡體中文版)Markdown語法說明(詳解版):我只看完了前面的簡體中文版枉圃,感覺詳解版類似就沒看了功茴,看完能夠發(fā)現(xiàn)一些小的tips,需要注意的點孽亲,推薦至少認(rèn)真看完一遍坎穿。
  5. Markdown 語法手冊從(完整整理版):總結(jié)的非常多,基本的確是完整整理版了返劲,但是里面也有一些問題作者沒有指出來玲昧,最大的問題就是并不是所有的解析器都支持某些語法,比如說上面的流程圖篮绿,估計是需要一些特殊配置酌呆。
  6. 使用Sublime Text 3寫Markdown:這個介紹了ST下的markdown環(huán)境配置,推薦看完搔耕,而且指了GFM的路。
  7. [譯] GitHub 風(fēng)格的 Markdown 語法:這個說了一些 GFM 和普通的 Markdown Extra 語法的一些區(qū)別痰娱,看了這個才明白前面完整整理版里面寫了一些語法可能不是所有的解析器都能夠解析弃榨,不過 MarkdownEditing 的配置可以選擇 github,所以這里寫的有些語法能夠渲染出來梨睁,試了一個 task list鲸睛,感覺很不錯。
  8. [譯] GitHub 上的書寫方式:這個大概掃了一遍坡贺,就是在 GitHub 上和別人交流的時候可以用的官辈,后續(xù)把 GitHub 用起來的時候再好好看看箱舞。
  9. 代碼塊可用的語言標(biāo)識符:代碼塊的起始三個`后面需要接一個語言標(biāo)識符,這樣才能對內(nèi)部代碼進(jìn)行高亮拳亿,之前代碼總是不能高亮晴股,還以為是插件配置的問題,后來才發(fā)現(xiàn)是少寫了個c肺魁。
  10. 我的總結(jié)之sublime text2中MarkdownEditing插件的安裝與markdown的編寫使用:這篇博客的名稱可真夠長的电湘,主要參考了后面總結(jié)的 MarkdownEditing 快捷鍵,其實這些也寫在了插件的默認(rèn)配置文件中鹅经,只是這里翻譯了一下寂呛,每個都試了,能用的就上面列舉的那些瘾晃,其他不能用主要是因為快捷鍵沖突贷痪,暫時先這樣,比較關(guān)鍵的快捷鍵還都用蹦误,感覺夠了劫拢。
最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市胖缤,隨后出現(xiàn)的幾起案子尚镰,更是在濱河造成了極大的恐慌,老刑警劉巖哪廓,帶你破解...
    沈念sama閱讀 219,270評論 6 508
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件狗唉,死亡現(xiàn)場離奇詭異,居然都是意外死亡涡真,警方通過查閱死者的電腦和手機(jī)分俯,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,489評論 3 395
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來哆料,“玉大人缸剪,你說我怎么就攤上這事《啵” “怎么了杏节?”我有些...
    開封第一講書人閱讀 165,630評論 0 356
  • 文/不壞的土叔 我叫張陵,是天一觀的道長典阵。 經(jīng)常有香客問我奋渔,道長,這世上最難降的妖魔是什么壮啊? 我笑而不...
    開封第一講書人閱讀 58,906評論 1 295
  • 正文 為了忘掉前任嫉鲸,我火速辦了婚禮,結(jié)果婚禮上歹啼,老公的妹妹穿的比我還像新娘玄渗。我一直安慰自己座菠,他們只是感情好,可當(dāng)我...
    茶點故事閱讀 67,928評論 6 392
  • 文/花漫 我一把揭開白布藤树。 她就那樣靜靜地躺著浴滴,像睡著了一般。 火紅的嫁衣襯著肌膚如雪也榄。 梳的紋絲不亂的頭發(fā)上巡莹,一...
    開封第一講書人閱讀 51,718評論 1 305
  • 那天,我揣著相機(jī)與錄音甜紫,去河邊找鬼降宅。 笑死,一個胖子當(dāng)著我的面吹牛囚霸,可吹牛的內(nèi)容都是我干的腰根。 我是一名探鬼主播,決...
    沈念sama閱讀 40,442評論 3 420
  • 文/蒼蘭香墨 我猛地睜開眼拓型,長吁一口氣:“原來是場噩夢啊……” “哼额嘿!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起劣挫,我...
    開封第一講書人閱讀 39,345評論 0 276
  • 序言:老撾萬榮一對情侶失蹤册养,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后压固,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體球拦,經(jīng)...
    沈念sama閱讀 45,802評論 1 317
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 37,984評論 3 337
  • 正文 我和宋清朗相戀三年帐我,在試婚紗的時候發(fā)現(xiàn)自己被綠了坎炼。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 40,117評論 1 351
  • 序言:一個原本活蹦亂跳的男人離奇死亡拦键,死狀恐怖谣光,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情芬为,我是刑警寧澤萄金,帶...
    沈念sama閱讀 35,810評論 5 346
  • 正文 年R本政府宣布,位于F島的核電站媚朦,受9級特大地震影響捡絮,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜莲镣,卻給世界環(huán)境...
    茶點故事閱讀 41,462評論 3 331
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望涎拉。 院中可真熱鬧瑞侮,春花似錦的圆、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,011評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至钮糖,卻和暖如春梅掠,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背店归。 一陣腳步聲響...
    開封第一講書人閱讀 33,139評論 1 272
  • 我被黑心中介騙來泰國打工阎抒, 沒想到剛下飛機(jī)就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人消痛。 一個月前我還...
    沈念sama閱讀 48,377評論 3 373
  • 正文 我出身青樓且叁,卻偏偏與公主長得像,于是被迫代替她去往敵國和親秩伞。 傳聞我的和親對象是個殘疾皇子逞带,可洞房花燭夜當(dāng)晚...
    茶點故事閱讀 45,060評論 2 355

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

  • atom編輯器的使用和markdown基本語法 atom介紹 atom是什么 Atom是github內(nèi)部的編輯軟件...
    Haoqian閱讀 35,568評論 3 39
  • (Markdown語法沒有一個統(tǒng)一的標(biāo)準(zhǔn),不同的工具或平臺采用的標(biāo)準(zhǔn)不一樣,所以有些語法規(guī)則和功能是有差異的) 0...
    遲道閱讀 56,821評論 4 69
  • 不識高頭馬纱新, 未尋萬家堂展氓。 杯中意氣盡, 曲終君王枯脸爱。 月未明遇汞,風(fēng)卷席。 樽中酒阅羹,慰風(fēng)塵勺疼。 殘燈枯等金甌生, 三花...
    惘過夕川閱讀 377評論 0 1
  • 產(chǎn)婦拖著疲憊的靈魂,默無聲息的走到窗臺前导梆,縱身一躍轨淌,一尸兩命。 榆林產(chǎn)婦跳樓事件看尼,近來已傳得沸沸揚揚递鹉。 到底是家屬...
    孤隱東坡閱讀 390評論 4 0
  • 2017年,我初二藏斩。 五歲的時候躏结,母親問我想學(xué)什么,我說我想學(xué)鋼琴狰域,可那時的我或許連鋼琴是什么都不知道吧~家人為我...
    wuli爸爸的白發(fā)不是老閱讀 204評論 0 0