markdown 語法

Cocowool發表於2021-06-22

我從2008年開始在部落格園寫技術類文件,最早的時候不知道Markdown,而且部落格園也沒有提供Markdown編輯器,當時都採用富文字編輯器來寫,每次調整格式都需要挺長時間。當時筆記軟體還用微軟的OneNote,因為也不支援Markdown,因此用的也還算平穩。

2014年以後部落格園開始支援Markdown,突然發現Markdown真的非常適合用來寫技術文件,只因為一個突出的優點:讓作者能夠專注到寫作本身,格式也能夠通過書寫的方式來實現,再也不用先寫文字再做格式調整的事情,這樣寫作流程連貫、一氣呵成,給人的感覺非常爽

再到後來筆記記錄軟體也切換成了「印象筆記」,也是一款支援Markdown編輯器的筆記軟體,但是它們家的Markdown編輯器效率不太好,比不上「有道筆記」。目前技術類的文章主要以Markdown的形式進行寫作,寫作軟體使用了「Typora」,部落格的管理使用了Hexo,經過一段時間的使用,我還整理了自己的寫作流程,具體內容在 為自己構建寫作的敏捷釋出流程Hexo部落格寫作與圖片處理的經驗 這兩篇文章中,今天只討論Markdown寫作的相關內容。

Markdown 歷史

Markdown 是一種輕量級標記語言,由約翰·格魯伯(John Gruber)在2004年建立。它允許人們使用易讀易寫的純文字格式編寫文件,然後轉換成有效的HTML文件或其他格式。由於Markdown的輕量化、易讀易寫特性,並且對於圖片、圖表、數學公式都有支援,使用的網站越來越多,目前Github、部落格網站等都支援使用Markdown語法來編寫文件和評論。

Markdown基本語法

1. 標題

在Markdown中,只要在文字前面加上 # 就可以定製標題。# 的數量代表了標題的級別,一個 # 號表示一級標題,級別越高,相應的字號越小。# 與標題文字之間,保留一個空格,這是標準的 Markdown 寫法。

2. 段落

Markdown中的段落和常規的文字編輯器一樣,使用空白行就能另起一個段落。注意在Markdown中編輯文字時,我們不需要考慮縮排,這些工作都應該交給輸出格式的轉換器。

3. 換行

使用Markdown格式編寫文件時,如果直接回車「Enter」會建立一個新的段落,如果只是想建立一個換行,則可以輸入「Shift + Enter」或使用HTML標記語言<br >

4. 粗體

使用兩個 * 或兩個 _ 將文字包圍起來表示對文字進行加粗。

5. 斜體

使用一個 * 或一個 _ 將文字包圍起來表示用斜體顯示文字。如果要同時應用粗體和斜體,則使用三個 * 或三個 _ 包圍文字即可。

6. 區塊引用

有時候需要對一段文字進行重點突出,可以使用區塊引用功能。在文字前加上 > 號就可以對一句話進行引用,如果是多行,則在每行前都加上 > 是最簡單的辦法。區塊中可以使用其他Markdown語法的元素,但不是全部支援。

7. 列表

列表有兩種,一種為無序列表,在文字前加 - 號或者 * 號或者 + 號即可;另一種為有序列表,使用 1. 的形式。注意所有的字元後面都要加上空格。

8. 程式碼引用

程式碼引用所使用的字元是引號,分為行內程式碼和多行程式碼,具體如下圖所示。

9. 連結和圖片

如果需要給文字加上鍊接,不需要點選圖示,需要將文字寫在方括號中,然後連結地址用括號包含起來放在方括號後面,效果展示如 顯示文字 。如果需要加入圖片,把圖片考慮為一個特殊的連結,前面加上歎號,則比較容易記住這種方式,圖片的註釋文字

10. 刪除線

使用兩個波浪線將文字包圍起來,表示對文字應用波浪線

11. 表格

新增表格,可以使用管道符分隔每列,並在標題和內容之間增加一行,用三個或多個連字元分隔。

| Syntax | Description |
| --- | ----------- |
| Header | Title |
| Paragraph | Text |

參考資料:

  1. 獻給寫作者的 Markdown 新手指南
  2. Markdown語法說明-簡體中文版
  3. Markdown 中文網
  4. 線上Markdown編輯器