如何在 Markdown 加入核取方塊：待辦清單語法與範例。

Markdown 待辦清單語法

待辦清單是一般清單，只是每個項目以核取方塊標記開頭。做法有三個部分：

1. 清單符號

   一個減號、星號或加號，後面接一個空格：-。像 1. 這樣的編號項目也可以。

2. 方括號中的方塊

   中間有一個空格的 [ ] 是未勾選的方塊，[x] 是已勾選的；大寫的 [X] 也算。括號之間不能放其他東西。

3. 一個空格，然後是文字

   ] 後面如果沒有空格，這一行就只是帶括號的純文字。

- [x] Draft the spec
- [x] Add the edge cases
- [ ] Get a review
- [ ] Hand it to the agent

讀者看到的樣子：

• Draft the spec
• Add the edge cases
• Get a review
• Hand it to the agent

巢狀核取方塊

把任務縮排在另一個任務下面，就成了子任務。多數渲染器用兩個空格即可，四個最保險：

- [ ] Release 2.0
    - [x] Update the changelog
    - [ ] Tag the build
    - [ ] Announce it
- [ ] Plan 2.1

同一份清單中可以混用任務與一般項目符號，也可以在任務下面放段落、程式碼或引用，只要縮排到與任務文字對齊。子項目全部完成時，父層的方塊不會自動勾選，需要你自己勾。

Markdown 核取方塊會在哪裡渲染

• GitHub 會在 Markdown 檔案、issue、pull request 與留言中把待辦清單顯示為核取方塊。在 issue 或 pull request 中，你可以直接在頁面上勾選，GitHub 會替你修改文字。
• 遵循 GFM 的 Markdown 應用程式也會顯示。在 DotMD 中，它們會在閱讀器裡以方塊呈現。這些方塊在閱讀器中是唯讀的：要勾選，請編輯該行，把 [ ] 改成 [x]。
• 只認識原始 Markdown 或 CommonMark 的精簡解析器會照原樣顯示文字與括號。它仍然讀起來像待辦清單，只是不是方塊。

使用 DotMD Editor 時，在任務結尾按 Enter，會以空的 - [ ] 開始下一項，讓你繼續輸入。

不用待辦清單的 Markdown 勾號

如果你想在表格或句子裡放一個勾，而不是做清單，直接輸入那個字元即可。Unicode 符號就是文字，所以每個 Markdown 應用程式都能顯示：

GitHub 也接受像 :white_check_mark: 這樣的表情符號簡碼。這是 GitHub 的功能：在其他應用程式中可能會顯示為原始文字，所以如果檔案會在別處閱讀，建議直接用字元。

計畫與規格中的待辦清單

待辦清單不只適用於待辦事項應用程式。用 Markdown 寫的計畫或規格，結尾常常是一份剩餘工作的檢查表，每一步都能在單獨一行上輕鬆審查：

## Tasks
- [x] Add the settings screen
- [ ] Write the migration
- [ ] Update the tests
- [ ] Update the docs

每個任務只包含一個能完成並檢查的動作。每一組用一個標題，只有子任務屬於同一個父項時才做巢狀。

待辦清單顯示括號而不是方塊的原因

• 括號後沒有空格：- [x]Done 不是任務。請寫成 - [x] Done。
• 括號內有空格：有兩個空格的 [ ]，或 [ x ]，都是純文字。
• 沒有清單符號：只以 [ ] 開頭的一行不是清單項目。
• 文字以括號開頭。GitHub 的文件說要跳脫括號：寫成 - [ ] \(Optional) Test it。
• 渲染器不支援 GFM。那麼不論怎麼寫，你看到的都是括號。

想確認含有任務的計畫長什麼樣子，請用 DotMD 開啟檔案，閱讀免費。規格與計畫常寫成待辦清單，有了方塊，很長的清單也容易掃讀。

關於 Markdown 核取方塊的常見問題

更多問題