DotMDMarkdownでチェックボックスを付けるには：タスクリストの書き方と例。
Markdownのチェックボックスは、角括弧で始まるリスト項目です。READMEや計画、仕様にToDoリストを持たせる、いちばん手軽な方法です。
macOS 14以降。閲覧は無料で、編集とレビューは1回のお支払いです。
要点
リスト項目の先頭に、空のボックスなら[ ]、チェック済みなら[x]を書き、閉じ括弧のあとにスペースを入れます。項目はインデントで入れ子にできます。タスクリストはGitHub Flavored Markdownの機能なので、GitHubやそれに対応するアプリではチェックボックスとして表示されます。
- [x] Write the plan
- [ ] Review it
- [ ] Fix the comments
- [ ] Ship it·
Markdownのタスクリストの書き方
タスクリストは、各項目がチェックボックスの印で始まる普通のリストです。要素は3つあります。
-
リストの記号
ハイフン、アスタリスク、プラスのいずれかのあとにスペース：
-。1.のような番号付きの項目でも使えます。 -
角括弧のボックス
中にスペースを1つ入れた
[ ]は空のボックス、[x]はチェック済みです。大文字の[X]も使えます。括弧の中にそれ以外は入れません。 -
スペース、そして本文
]のあとにスペースがないと、その行は括弧付きのただのテキストのままです。
- [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
入れ子のチェックボックス
別のタスクの下にインデントすると、サブタスクになります。多くのレンダラーではスペース2つで動きますが、4つがいちばん確実です。
- [ ] Release 2.0
- [x] Update the changelog
- [ ] Tag the build
- [ ] Announce it
- [ ] Plan 2.1同じリストの中でタスクと通常の箇条書きを混ぜられます。また、タスクの本文の位置に合わせてインデントすれば、タスクの下に段落、コード、引用を置けます。子のタスクがすべて終わっても、親のボックスは自動ではチェックされません。自分でチェックします。
Markdownのチェックボックスが表示される場所
- GitHubは、Markdownファイル、Issue、プルリクエスト、コメントでタスクリストをチェックボックスとして表示します。Issueやプルリクエストではページでボックスをクリックすると、GitHubがテキストを書き換えてくれます。
- GFMに対応するMarkdownアプリでも表示されます。DotMDではリーダー上にボックスとして表示されます。ここでのボックスは読み取り専用です。チェックするには、その行の
[ ]を[x]に書き換えます。 - 元のMarkdownやCommonMarkしか知らない最小限のパーサーでは、括弧付きのテキストがそのまま表示されます。ToDoリストとしては読めますが、ボックスにはなりません。
DotMD Editorでは、タスクの行末でEnterを押すと、空の- [ ]で次のタスクが始まるので、そのまま項目を打ち続けられます。
タスクリストを使わないMarkdownのチェックマーク
リストではなく、表や文の中にチェックを入れたいときは、その文字をそのまま入力します。Unicodeの記号はテキストなので、どのMarkdownアプリでも表示されます。
| 文字 | 名称 |
|---|---|
| ✓ ✔ | チェックマーク、太いチェックマーク |
| ✅ | 白い太いチェックマーク（絵文字） |
| ☑ ☐ | チェック入りの投票用の枠、空の投票用の枠 |
| ✗ ✘ ❌ | バツ印、太いバツ印、クロスマーク（絵文字） |
GitHubでは:white_check_mark:のような絵文字ショートコードも使えます。これはGitHubの機能で、ほかのアプリでは文字列のまま表示されることがあります。ファイルをほかの場所で読む可能性があるなら、文字そのものを使ってください。
計画や仕様でのタスクリスト
タスクリストはToDoアプリだけのものではありません。Markdownで書いた計画や仕様は、最後に残りの作業のチェックリストを置くことが多く、各ステップを1行ずつ確認しやすくなります。
## Tasks
- [x] Add the settings screen
- [ ] Write the migration
- [ ] Update the tests
- [ ] Update the docs各タスクは、終わらせて確認できる1つの作業にします。グループごとに見出しを付け、サブタスクは1つの親に属する場合だけ入れ子にします。
タスクリストがボックスではなく括弧で表示されるとき
- 括弧のあとにスペースがない：
- [x]Doneはタスクではありません。- [x] Doneと書きます。 - 括弧の中のスペース：スペース2つの
[ ]や[ x ]は、ただのテキストです。 - リストの記号がない：
[ ]だけで始まる行は、リスト項目ではありません。 - 丸括弧で始まる本文。GitHubのドキュメントでは、丸括弧をエスケープするよう案内しています。
- [ ] \(Optional) Test itと書きます。 - レンダラーがGFMに対応していない。その場合は、どう書いても括弧が見えます。
タスク入りの計画がどう見えるか確認するには、DotMDでファイルを開きます。閲覧は無料です。仕様や計画はタスクリストで書かれることが多く、ボックスがあると長いリストも見渡しやすくなります。
Markdownのチェックボックスに関するよくある質問
Markdownでチェックボックスを作るには？
リスト項目の先頭に、空のボックスなら[ ]、チェック済みなら[x]を書き、スペースと本文を続けます：- [ ] Buy milk。これはGitHub Flavored Markdownなので、対応するアプリが必要です。
Markdownのチェックボックスをクリックしてチェックできますか？
GitHubのIssueやプルリクエストではできます。ページがテキストを書き換えてくれます。Markdownファイルでは、テキスト中の[ ]を[x]に書き換えます。DotMDのリーダーでは、ボックスは読み取り専用です。
Markdownでチェックマークを付けるには？
文字をそのまま入力します：✓、✔、✅、☑。これらは通常のUnicodeなので、どのアプリでも表示されます。リストにクリックできそうなボックスを付けたいときは、代わりに- [x]を使います。
入れ子のチェックボックスは使えますか？
はい。サブタスクを親の下にインデントします。サブタスクがすべて終わっても、親は自動ではチェックされません。