1. 程式人生 > >一份簡明的 Markdown 筆記與教程

一份簡明的 Markdown 筆記與教程

自從 2014 年左右接觸到 Markdown 以來,對它的使用就一發而不可收拾。從最開始使用它在 GitHub Pages 裡寫部落格,到用它編輯專案的 README 檔案,再到撰寫開發文件,編輯微信公眾號文章和郵件內容等等,這期間也見證了它在各類平臺和網站上的普及和被原生支援,可以說,Markdown 如今已經滲透了我在技術和網路活動的方方面面,成為了我撰寫文字文件的首選。

那麼首先我們一起來看一下它的「定義」:

Markdown 是一種輕量級標記語言,創始人為 John Gruber。它允許人們「使用易讀易寫的純文字格式編寫文件,然後轉換成有效的 XHTML(或者 HTML)文件」。——維基百科

本文件的目的不在於面面俱到地介紹 Markdown,只是作為我對其理解的筆記整理,希望能同時幫助一些對 Markdown 感興趣的人快速上手,或是作為一個工具,供對其已經有所瞭解的人在需要時參考。

接下來請隨我一起深入瞭解這門並不神祕的實用標記語言。

背景

優點

  1. 專注於文字內容;

  2. 純文字,易讀易寫,可以方便地納入版本控制;

  3. 語法簡單,沒有什麼學習成本,能輕鬆在碼字的同時做出美觀大方的排版。

使用場景

  • 各類程式碼託管平臺

    主流的程式碼託管平臺,如 GitHub、GitLab、BitBucket、Coding、Gitee 等等,都支援 Markdown 語法,很多開源專案的 README、開發文件、幫助文件、Wiki 等都用 Markdown 寫作。

  • 技術社群和寫作平臺

    StackOverflow、CSDN、掘金、簡書、GitBook、有道雲筆記

  • 論壇

    V2EX、光谷社群

個人感覺比較遺憾的一點是各平臺可能採用不同語言實現的 Markdown 解析引擎,或採用同一解析引擎的不同版本,而且可能有不同程度的定製與擴充套件,這導致在不同平臺上使用 Markdown 寫作時體驗並不完全一致。不過幸好對於大家公認的一些標準語法,各