Markdown 筆記的基本寫法:把內容寫得可讀、可搬遷

Markdown 是 John Gruber 在 2004 年提出的輕量標記語法。它的好處不在於能取代所有 HTML,而是讓文章先以可閱讀的純文字保存;同一份內容放進筆記、版本控制或 CMS 時,仍能看懂結構。

我現在把它當成整理技術筆記的起點:先把標題、步驟、程式碼和來源寫清楚,最後才處理版面。這樣日後換編輯器或搬站時,不會只剩一段難維護的 HTML。

最常用的幾種寫法

標題與段落

# 文章標題
## 第二層標題

這是一個段落。段落之間要留一個空白行。

井字號的數量決定層級。標題要按照內容層次使用,不要只是為了把字放大;這對目錄、螢幕閱讀器和日後搜尋都比較友善。

清單

- 無序項目
- 另一個項目

1. 有序步驟
2. 下一步

需要讓讀者照順序操作時,用有序清單;只是列出重點時則用無序清單。巢狀清單最常因縮排不一致而失敗,預覽後再發布會省下很多排版時間。

連結與圖片

[連結文字](https://example.com)
![圖片替代文字](https://example.com/image.jpg)

連結文字應描述目的地,不要只寫「點這裡」。圖片的替代文字則要說明圖片內容或它在步驟中扮演的角色;當圖片無法載入時,讀者仍能知道少了什麼。

程式碼與引用

行內程式碼可用 `code` 包住。

```bash
npm run build
```

> 這是一段引用。

多行程式碼最好標示語言,例如 bash、json 或 csharp,方便閱讀器做語法上色。引用區塊適合放來源重點或原始錯誤訊息,但不要拿來取代自己的說明。

水平線與少量 HTML

---
***
___

以上三種寫法都可建立水平線。Markdown 也通常允許穿插 HTML,例如 <table> 或 <details>,但混用前要確認目前的編輯器與主題是否支援。能用 Markdown 表達時,優先保持簡單,匯出或搬遷時會更穩定。

發布前的檢查

  • 標題是否按照層級排列,而非跳過 h2 直接使用 h4。
  • 連結與圖片是否有明確的文字說明。
  • 程式碼區塊是否保留了可複製的原始內容。
  • 不同編輯器的擴充語法(表格、任務清單、數學式)是否已在目標平台預覽過。

Markdown 沒有一份所有平台都完全一致的延伸語法;當內容需要在多個工具之間流動時,以 CommonMark 的基本規則為底,再另外標示平台特有功能,會比依賴隱性的格式來得可靠。

參考資料

Author image
關於 Richard Zheng
About me 喜歡爬山,瑜伽,溜冰,喜歡新奇的事,最喜歡的還是寫程式帶來的成就感,對於資訊會不斷的出現新事物也能抱持好奇與熱忱。近期開始將學習的心得寫在Blog,發現思路更清晰也加深了記憶。 紙上得來終覺淺,絕知此事要躬行