Lists

How to create unordered lists

Mau supports the creation of unordered lists. You can create them using one or more characters * according to the level of the element

Mau source code
* List item
** Nested list item
*** Nested list item
* List item
** Another nested list item
* List item
  • List item
    • Nested list item
      • Nested list item
  • List item
    • Another nested list item
  • List item

How to create ordered lists

You can use the character # to create an ordered list

Mau source code
# Step 1
# Step 2
## Step 2a
## Step 2b
# Step 3
  1. Step 1
  2. Step 2
    1. Step 2a
    2. Step 2b
  3. Step 3

Mixed lists

You can mix ordered and unordered lists

Mau source code
* List item
** Nested list item
### Ordered item 1
### Ordered item 2
### Ordered item 3
* List item
  • List item
    • Nested list item
      1. Ordered item 1
      2. Ordered item 2
      3. Ordered item 3
  • List item

Lists and spaces

All spaces before or after the initial characters are ignored.

Mau source code
* List item
  ** Nested list item
    *** Nested list item
*   List item
  **    Another nested list item (indented)
*   List item
  • List item
    • Nested list item
      • Nested list item
  • List item
    • Another nested list item (indented)
  • List item

Starting index

For ordered lists, the default starting index is 1, but this can be changed setting an attribute.

Mau source code
[start=42]
# Step 1
# Step 2
## Step 2a
## Step 2b
# Step 3
  1. Step 1
  2. Step 2
    1. Step 2a
    2. Step 2b
  3. Step 3

Split a list

Sometimes, it's useful to have lists split in multiple sections, and have each section continue automatically from the previous one. This can be done setting start=auto

Mau source code
[start=42]
# Step 1
# Step 2

This is a paragraph that interrupts the list

[start=auto]
# Step 3
# Step 4

This is another paragraph that interrupts the list

[start=auto]
# Step 5
# Step 6
  1. Step 1
  2. Step 2

This is a paragraph that interrupts the list

  1. Step 3
  2. Step 4

This is another paragraph that interrupts the list

  1. Step 5
  2. Step 6

Labels and arguments

Lists support arguments and labels.

Mau source code
[arg, #tag, *subtype, key=value]
* A list
* With arguments

Control conditions

Lists also support control conditions.

Mau source code
:var:42

// This will be rendered.
@if var == 42
* A list

// This will NOT be rendered.
@if var == 43
* Another list