Lists

The Three List Types

Lists can appear in various forms:

Unordered lists have no clear sequence. They can be created in AsciiDoc using either * or -. By pressing the Enter key, another bullet point can be added directly. If you press Enter again in the new bullet point without text, the list is closed.

description list

Ordered lists are numbered and have a clear sequence. They can be created directly by entering 1., 2., etc. However, this numbering remains static even if you change the order. We therefore recommend writing ordered lists with ..

structured list

This way the numbering is adjusted dynamically, even if you change the order of individual list items.

Description lists pair an expression with an explanation. The syntax is: `Term

Description`.

By default, this creates a vertical description list. Each entry gets its own line, and the description appears beneath the expression. You can switch the layout to a horizontal description list by adding the [horizontal] block attribute directly above the list.

unstructured list

Nested Lists

Lists can be nested to any depth. Simply add more characters:

* Level 1
** Level 2
*** Level 3

The result:

  • Level 1

    • Level 2

      • Level 3

Ordered lists work the same way with additional dots:

. First item
.. Sub-item a
.. Sub-item b
. Second item

Checklists

For task lists, you can use checklists:

* [x] Done
* [ ] Still open
* [x] Also done

The result:

  • Done

  • Still open

  • Also done

If you need complex content like paragraphs or code blocks in a list item, use the + character on its own line to attach the content. 
* First item
+
This paragraph still belongs to the first item.
+
And so does this one.
* Second item

The result:

  • First item

    This paragraph still belongs to the first item.

    And so does this one.

  • Second item