Markdownのチェックボックスとタスクリスト
[ ] で始まるリスト項目は空のチェックボックスに、[x] で始まる項目はチェック済みになります。タスクリストの書き方、よくある間違い、クリックでチェックできるアプリを説明します。
要点
Markdownでチェックボックスを作るには？
リストの記号のあとに角括弧を書きます。- [ ] タスク は空のチェックボックス、- [x] タスク はチェック済みです。タスクリストはGitHub Flavored Markdownの記法で、GitHub、GitLab、Obsidianなど多くのエディタで使えます。
Markdown
- [x] タイトルを決める
- [ ] 下書きを書く
- [ ] レビューを頼む表示結果
- タイトルを決める
- 下書きを書く
- レビューを頼む
タスクリストの書き方と例
タスクは先頭に角括弧が付いた普通のリスト項目なので、リストで使える書き方はここでも使えます。
未完了と完了
角括弧の中に空白を入れると未完了、x を入れると完了です。大文字の X も使えます。
Markdown
- [ ] 未完了のタスク
- [x] 完了したタスク
- [X] これも完了表示結果
- 未完了のタスク
- 完了したタスク
- これも完了
番号付きのタスク
番号のあとにも角括弧を書けます。順番どおりに進める手順に向いています。
Markdown
1. [x] データベースをバックアップする
2. [ ] 移行を実行する
3. [ ] ログを確認する表示結果
- データベースをバックアップする
- 移行を実行する
- ログを確認する
入れ子のタスク
タスクを別のタスクの下に字下げすると、細かい手順に分けられます。
Markdown
- [ ] 新しいサイトを公開する
- [x] リリースノートを書く
- [ ] スクリーンショットを更新する表示結果
- 新しいサイトを公開する
- リリースノートを書く
- スクリーンショットを更新する
書式やリンクを含むタスク
角括弧のあとの文には、太字、リンク、取り消し線を使えます。
Markdown
- [x] ~~ログインの不具合を直す~~
- [ ] [プルリクエスト](https://example.com/pull/42)を確認する
- [ ] バージョン2.0を**リリース**する表示結果
-
ログインの不具合を直す - プルリクエストを確認する
- バージョン2.0をリリースする
チェックボックスにならない書き方
角括弧の中には空白か x が必要で、角括弧のあとには空白が必要です。また、その行がリスト項目である必要があります。
Markdown
- [] 角括弧の中が空
- [x]角括弧のあとに空白がない
[ ] リストの記号がない表示結果
- [] 角括弧の中が空
- [x]角括弧のあとに空白がない
[ ] リストの記号がない
GitLab：不要になったタスク
GitLabには3つ目の状態 [~] があり、不要になったタスクを表します。
Markdown
- [x] コードを書く
- [~] ドキュメントを翻訳する
- [ ] リリースするGitLabだけの書き方です。ほかのMarkdownアプリでは表示が異なるため、プレビューはありません。
各サービスでの対応状況
GitHub Flavored Markdownに従うアプリならチェックボックスが表示されます。クリックできるかどうかはアプリとページによって異なります。
| サービス | 対応 | 補足 |
|---|---|---|
| GitHub | 対応 | Issue、PR、コメントではクリックでき、ファイルでは表示のみです。 |
| GitLab | 対応 | Issueとマージリクエストでクリックできます。[~] は不要になったタスクです。 |
| Obsidian | 対応 | 閲覧画面とライブプレビューでクリックできます。 |
| Notion | 違いあり | [] と入力するとToDoのブロックになります。 |
| Discord | 非対応 | 角括弧はそのまま表示されます。 |
| Slack | 非対応 | メッセージにチェックボックスはありません。 |
よくある質問
チェックボックスが表示されないのはなぜですか？
行が
- などのリストの記号で始まっているか、角括弧の中に空白か x があるか（[] は無効）、] のあとに空白があるか、アプリがGitHub Flavored Markdownに対応しているかを確認します。チェックボックスはクリックできますか？
GitHubとGitLabのIssue、プルリクエスト、コメントではクリックでき、文字も書き換わります。表示されたファイルや多くのプレビューでは表示のみです。
大文字の X も使えますか？
使えます。
[X] と [x] はどちらも完了を表します。タスクを入れ子や番号付きにできますか？
できます。タスクを別のタスクの下に字下げすると入れ子になり、
1. [ ] と書くと番号付きになります。リストの外にチェックボックスを置くには？
Markdownがチェックボックスを作るのはリスト項目の中だけです。リストの外では ☐ や ☑ の文字を直接入力します。
Notion、Discord、Slackでチェックボックスは使えますか？
Notionでは
[] と入力するとToDoのブロックになります。DiscordとSlackにはチェックボックスがなく、角括弧がそのまま表示されます。GitHubはタスクをどう数えますか？
GitHubはプルリクエストの説明文にあるチェックボックスを数え、プルリクエストの一覧に「1 of 3 tasks」のような進み具合を表示します。
タスクリストはどんなHTMLになりますか？
各タスクは
<input type="checkbox" disabled> で始まるリスト項目になり、完了したタスクには checked が付きます。