Checklists

On this page, you’ll learn:

  • How to mark up a checklist with AsciiDoc.

  • How to create an clickable checklist with AsciiDoc.

Checklist syntax

Task lists are unordered lists that have list items marked as checked or not checked.

Here’s an example:

Example 1. Checklist syntax
* [*] checked
* [x] also checked
* [ ] not checked

The result of Example 1 is rendered below.

  • checked

  • also checked

  • not checked

If you want to make the checkbox clickable, add the interactive option to the checklist, which is shown here using the shorthand syntax (%) for options.

Example 2. Interactive checklist syntax
[%interactive]
* [ ] Binge watch Death in Paradise
* [ ] Visit a tropical island

The result of Example 2 is rendered below. Go ahead, click a box.

  • Binge watch Death in Paradise

  • Visit a tropical island

AsciiDoc and Asciidoctor resources