這份速查表怎麼用

重點摘要
  • 第一張表是基本語法:十個元素,所有 Markdown 工具都支援。
  • 第二張表是延伸語法:表格、待辦清單、註腳等,多數現代工具支援。
  • 最後一節直說哪個平台會默默忽略哪個語法。
  • 這裡沒有一項需要背。查到你不用再查為止就好。

按照你會用到的順序排列

速查表是拿來瞄的,不是拿來背的。下面兩張表按照實際使用順序排列。基本語法排前面,因為那十個元素就涵蓋了九成以上的日常寫作。延伸語法排後面,留給需要表格或待辦清單的時候。

開著編輯器學最快

一個分頁開這份速查表,另一個分頁開我們的免費 Markdown 編輯器。複製一段範例貼進去,即時預覽馬上顯示結果。同一個語法親手打三四次、每次都有立即回饋,比看三十次有效得多。肌肉記憶就是這樣養成的。

多數人輕度使用一週後,就只剩註腳這類冷門語法需要回來查。如果你想懂的是每個語法背後的原理,而不只是它長什麼樣子,完整的 Markdown 教學指南有更深入的說明。

印出來貼在螢幕旁

這個頁面列印起來很乾淨,表格也不會跑版。紙本放在螢幕旁邊的效果比想像中好,因為答案就在視線餘光裡,不必切換分頁去找。

小提醒:按下 Ctrl+P(Mac 上是 ⌘P),本頁會印成整齊的兩頁參考卡。印一次,就不用每週再搜尋同樣那三個符號。

注意:某段語法沒有照預期渲染時,先懷疑空格,再懷疑語法。少了空行,或 # 後面少了空格,就是大部分問題的原因。請寫 # 標題,不要寫 #標題

插圖:鍵盤旁放著一張印出來的快速參考卡,Markdown 符號被特別標示

基本語法 - 所有 Markdown 工具都支援

以下十個元素來自 John Gruber 在 2004 年的原始 Markdown 設計。世界上每一個 Markdown 處理器都支援它們,放心在任何地方使用。

元素Markdown 語法效果
標題# H1   ## H2   ### H3章節標題,共 1–6 級。# 後面的空格不能省略。
粗體**粗體文字**粗體文字
斜體*斜體文字*斜體文字
引言> 引用的文字縮排的引用區塊;多行引用就在每行前面都加 >
有序清單1. 第一項
2. 第二項
編號清單。你打的數字不必連續,渲染器會自動重新編號。
無序清單- 第一項
- 第二項
項目符號清單。*+ 也可以,但同一份文件請統一用一種。
行內程式碼`code`句子中的等寬程式碼
分隔線---橫貫頁面的分隔線(上下都要留空行)。
連結[標題](https://example.com)可點擊的連結:方括號放文字,圓括號放網址。
圖片![替代文字](image.jpg)嵌入圖片 - 寫法和連結一樣,只是前面多一個 !

兩條空格規則,解決大半問題

新手的疑問幾乎都回到同一件事:空白。段落之間要有空行。清單符號和 # 後面一定要加空格。這兩個習慣做對,基本語法就會乖乖聽話。

想一次專心看一個元素、看得更仔細?語法總覽為每個元素都準備了獨立的說明頁。

延伸語法(GFM 與其他擴充)

這些元素是後來由 GitHub 風格 Markdown(GFM)和其他處理器加入的。多數現代工具支援其中大部分,但沒有一個工具支援全部。使用冷門語法前,請先看下面的可靠度分級。

元素Markdown 語法效果
表格| 欄 A | 欄 B |
| ---- | ---- |
| 內容 | 內容 |
資料表格。對齊與跳脫請見表格完整指南
圍欄式程式碼區塊```python
print("hi")
```
多行程式碼區塊;在開頭圍欄後加語言名稱即可啟用語法上色。
註腳正文加註。[^1]
[^1]: 註腳內容。
上標編號,點擊會跳到文件底部的註解。
刪除線~~刪掉的文字~~刪掉的文字
待辦清單- [x] 已完成
- [ ] 未完成
帶核取方塊的清單 - 在 GitHub 議題中還可以直接點選。
螢光標記==重點文字==螢光筆效果 - 注意:這不是 GFM 的一部分,只有 Obsidian 等部分筆記軟體支援。
下標/上標H~2~O   x^2^H2O 與 x2 - 只有少數處理器支援;在 GitHub 上請改用 HTML 標籤 <sub><sup>

每個延伸語法有多可靠?

大致由穩到不穩:

  • 幾乎到處能用 - 表格、圍欄式程式碼區塊、刪除線、待辦清單。凡是建立在 GFM 上的工具都渲染得出來,而那幾乎就是現代網路的全部。
  • 多半沒問題 - 註腳。GitHub、Obsidian 和多數靜態網站產生器都支援;聊天軟體和 Notion 不支援。
  • 只在單一軟體有效 - 螢光標記、上標、下標。把它們當成該軟體的方便功能,別當成可以搬來搬去的 Markdown。

表格出包的次數比其他語法加起來還多,而且原因都很無聊。表格完全指南把對齊、跳脫管線符號,以及那些讓表格塌成純文字的小錯誤都寫清楚了。

哪些語法在哪裡能用:誠實的相容性整理

Markdown 最常見的挫折是這樣的:在 A 工具好好的語法,貼到 B 工具卻毫無反應。以下是常用平台的實際狀況。

GitHub 是延伸語法的基準

在 README、議題(issue)和拉取請求(PR)裡:

  • 可以用 - 表格、附語法上色的程式碼區塊、待辦清單、刪除線、註腳。
  • 不能用 - 螢光標記(==文字==),以及 ~x~^x^ 這類上下標捷徑。
  • 要小心 - GitHub 會把單一波浪號的 ~文字~ 當成刪除線,而不是下標。
  • 替代做法 - 在 GitHub 上請改用 HTML 標籤 <sub><sup>

Discord 與 Reddit:聊天室的規矩

兩者都支援行內基本語法,並且拿掉大部分區塊級的延伸功能。

  • Discord - 粗體、斜體、刪除線、行內程式碼、程式碼區塊、引言,以及 2023 年起一般訊息中的標題與項目清單。沒有表格、沒有待辦清單、沒有註腳,也不能用語法插圖片 - 圖片只能用附件。另外 Discord 用雙底線 __底線__ 表示底線,這是非標準的自家用法。
  • Reddit - 基本語法,加上表格、刪除線,以及 Reddit 專屬的防雷語法 >!劇透!<。註腳和待辦清單不會渲染。舊版 Reddit 的表格支援沒問題;行內圖片則要看社群開不開放。

Notion 與 Obsidian:筆記軟體

  • Notion - 只把 Markdown 當輸入方式。打 # 加空格會變成標題區塊,但所有內容立刻轉成 Notion 自己的區塊。貼上 Markdown 表格會變成 Notion 表格。註腳和螢光標記語法不被認得,匯出回 Markdown 也不保證完全一致。
  • Obsidian - 這幾個裡面支援最完整的。上面兩張表的語法全都能用,包括註腳和 ==螢光標記==。它還多了自家的 wiki 連結 [[像這樣]],但那在別的地方都不能用。

如果這兩套是你的日常主力,我們另外寫了 Markdown 在 NotionMarkdown 在 Obsidian 的專篇。其餘平台則整理在平台總覽

最安全的策略

日常寫作預設用基本語法。目標平台是 GitHub 或相容 GFM 的工具(例如本站編輯器)時,再放心使用 GFM 延伸。至於螢光標記、上下標和 wiki 連結,就當成特定軟體的方便功能,別指望它們能帶著走。

相容性資料驗證日期

常見問題

這些語法全部都要背起來嗎?

不用。標題、粗體、斜體、清單、連結、程式碼這十個元素就涵蓋了幾乎所有寫作需求。在編輯器裡搭配即時預覽用個幾天,自然就記住了。冷門語法再回來查就好。

基本語法和延伸語法差在哪?

基本語法是 2004 年的原始 Markdown 規格,所有 Markdown 工具都支援。延伸語法(表格、待辦清單、刪除線、註腳)是後來由 GitHub 風格 Markdown 等處理器加入的 - 支援度很廣,但並非人人都有。

為什麼我的語法沒有渲染出來?

十次有九次是空格問題:# 或清單符號後面少了空格,或區塊之間少了空行。剩下的一次通常是你在不支援該延伸語法的工具裡使用它 - 請對照上面的相容性整理。

這份速查表可以列印嗎?

可以 - 直接用 Ctrl+P⌘P 列印本頁即可。表格列印起來很乾淨,兩頁就能放下。把紙本貼在螢幕旁邊,是內化語法最快的方法之一。

延伸閱讀

立即使用編輯器

立即使用編輯器