Markdown
Markdown 是一種輕量標記語言,2004 年由 John Gruber 與 Aaron Swartz 設計。它用最少的符號表達標題、列表、連結、強調和代碼塊,寫出來的純文本即使不渲染也能讀。最初只是一個把 Markdown 轉成 HTML 的 Perl 腳本,後來變成了寫文檔的通用格式。[1]
Markdown 標誌 | |
| 設計者 | John Gruber、Aaron Swartz |
|---|---|
| 首次發布 | 2004年3月 |
| 標準 | CommonMark |
| 類型 | 輕量標記語言 |
| 官方網站 | daringfireball.net |
Markdown 的流行和 GitHub 分不開。README、issue、pull request 和評論都支持 Markdown,很多人的第一篇技術文檔就是用井號標題和短橫線列表寫的。
歷史
編輯2004 年,John Gruber 在 Aaron Swartz 的幫助下發布了 Markdown。它的目標是讓寫作者用純文本寫作,同時能方便地轉成 HTML。Gruber 寫了最初的 Perl 轉換腳本,但很長一段時間裏,Markdown 只有語法說明,沒有正式規範。
各家的解析器對邊界情況處理不一致,同一個文件在不同工具里可能渲染出不同結果。2014 年,CommonMark 項目開始制定嚴格規範;2017 年發布 1.0 版。
語法
編輯Markdown 的語法很少。行首的井號表示標題,短橫線或數字加句點表示列表,星號或下劃線包裹文字表示強調,方括號加圓括號表示連結,反引號包裹代碼,三個反引號包裹代碼塊。大於號表示引用,連續三個短橫線表示分隔線。
Markdown 允許直接嵌入 HTML。這很方便,但也導致不同實現的行為不一致。表格、任務列表、刪除線和自動連結最初不在 Markdown 里,是 GitHub 等平台後來加的擴展。
標準化與方言
編輯CommonMark 用測試用例定義每個語法細節,解決了很多歧義。GitHub 在 CommonMark 基礎上加入表格、任務列表、刪除線和自動連結,形成 GitHub Flavored Markdown(GFM)。GFM 現在是很多文檔工具的事實標準。
除此之外還有 Markdown Extra、MultiMarkdown、MDX 等方言。MDX 允許在 Markdown 里寫 React 組件,常用於文檔站點。
應用
編輯Markdown 被用於代碼倉庫的 README 和文檔、靜態網站生成器(Hugo、Hexo、VitePress、MkDocs)、筆記軟件(Obsidian、Logseq、Typora)、論壇和評論系統。配合 Pandoc,它還可以轉成 PDF、LaTeX 和 Word。
Markdown 不是為複雜排版設計的。精細的表格、腳註、交叉引用和數學公式通常要擴展語法,或者換用 AsciiDoc、LaTeX。