Asciidocの表の中でチェックボックスを使う

3077 ワード
asciidoc asciidoctor asciidoctor テキストリンク

確認環境

AtomのAsciiDoc Preview 2.10.2

そもそもAsciidocでチェックボックスを書くには

Asciidocでチェックボックスを書くには

checklist.adoc
* [*] checked
* [x] also checked
* [ ] not checked

と書くように、ドキュメントに書かれています。
↓出力例

が、表の中に書こうとすると[ ]がそのまま出てしまいます。

表の中にチェックボックスを書くには

+++で囲った文書またはpass:[]の[]内に書いた文書ではHTMLタグが使用できるので、↓のように書くと表の中でもチェックボックスを表示することができます。

checklist.adoc
+++<input type="checkbox">+++
pass:[<input type="checkbox">]

単にチェックマークを書くのが目的なら↓のようにも書けます。

checklist.adoc
icon:check[]
✓
&#10003;

出力結果

より簡潔に表の中でチェックボックスを使う

9/20 追記しました。azarasiさん、ありがとうございます！

tableを書く際に、cols属性で幅を指定しますが、数字の後ろにaをつけると、その列ではAsciiDocの記法が有効になります。

[cols="50,50a"]
|===
|タスク名
|完了？

|タスク１
|
* [*] checked
* [x] also checked
* [ ] not checked

|タスク２
|
* [x] checked

|タスク３
|
* [ ] not checked
|===

↓出力結果

参考：
- Add support for checklist in table
- Asciidoctor User Manual -43. Passthroughs-

この投稿に至った経緯

これまでドキュメントをmarkdownで記述していましたが、AsciiDocがプロジェクトで採用されたため、書き方を調べていました。