Markdown でチェックボックスを書くには? チェックできないのはなぜ?
チェックボックスは、箇条書きの記号のあとに [ ] を書いて、- [ ] やること とします。チェック済みにするときは、かっこの中を x にして - [x] やること と書きます。これは GitHub の拡張(GFM)のタスクリストの書き方で、標準の CommonMark にはありません。
表示されたチェックボックスを押してチェックできるかどうかは、アプリやサイトによって違います。GFM の仕様は押したときの動きを決めておらず、押せない表示にしてもよいとしています。押せないときは、元の文字の [ ] を [x] に書き換えます。
チェックボックスは、どう書く?
- [ ] 牛乳を買う - [x] 洗濯をする - [ ] 本を返す - [x] 図書館の場所を調べる
- 記号(
-)のあとに空白、[、空白かx、]、空白、の順に書きます。かっこの中の空白を忘れて[]にすると、チェックボックスになりません。 - チェック済みの
xは、小文字でも大文字(X)でもかまいません。 - 字下げすれば、入れ子にもできます。
チェックボックスが押せない・チェックできないのはなぜ?
GFM の仕様は、チェックボックスを表示することだけを決めていて、押したときにどうするかは決めていません。仕様の例でも、チェックボックスは押せない形(disabled)で出力されています。押してチェックできるかどうかは、表示するアプリやサイトの作りによります。
GitHub では、コメントなどに書いたタスクリストのチェックボックスを押して、完了・未完了を切り替えられます(GitHub Docs)。押せないアプリでは、編集の画面で [ ] を [x] に書き換えます。
表の中や、取り消し線と組み合わせられる?
- 表の中: チェックボックスはリストの項目にだけ書けるので、表のセルに
[ ]を書いても、チェックボックスにはなりません。 - 取り消し線と組み合わせる:
- [x] ~~牛乳を買う~~のように、文を~~で囲めば、チェックと取り消し線を一緒に出せます。チェックしただけでは、取り消し線は自動ではつきません(つけるアプリもあります)。