Lists
MMX supports three list styles. All of them use indentation (tabs or spaces) to indicate nesting level.
Unordered lists
Start a line with - followed by a space and your item text. Use additional - characters to nest a sub-item.
- item
- item
-1 item with 1 tab
-2 item with 2 tabs
-2 item with 2 tabs
-1 item with 1 tab
- item
Result:
- item
- item
- item with 1 tab
- item with 2 tabs
- item with 2 tabs
- item with 1 tab
- item with 1 tab
- item
Ordered lists (auto-numbered)
Start a line with + to get an automatically numbered list (1, 2, 3, ...). Indent with more + characters to nest.
+ item
+ item
+1 item with 1 tab
+2 item with 2 tabs
+2 item with 2 tabs
+1 item with 1 tab
+ item
Result:
- item
- item
- item with 1 tab
- item with 2 tabs
- item with 2 tabs
- item with 1 tab
- item with 1 tab
- item
Ordered lists (manual numbers)
If you want to control the starting number, write it explicitly using n. at the start of each line.
1. item
2. item
3.1 item with 1 tab
4.2 item with 2 tabs
5.2 item with 2 tabs
6.1 item with 1 tab
7. item
Result:
- item
- item
- item with 1 tab
- item with 2 tabs
- item with 2 tabs
- item with 1 tab
- item with 1 tab
- item
Task lists (checklists)
Start a list item with [ ] followed by a space to render a checkbox
that the reader can click to mark the item as done. Use [x] (or [X])
to render the checkbox already checked. The marker is removed from
the visible text and replaced with a clickable checkbox.
The checked state is purely visual for the current session: the
documentation generator never stores it, so reloading the page (or
rebuilding the docs) resets every checkbox back to whatever the.mmx file says.
- [ ] first unchecked task
- [x] second task, already done
Result:
- first unchecked task
- second task, already done
Mixing styles
You can mix auto-numbered and manual-numbered items in the same list.
+ item
5. item //this will not work because starting from a different number only works at the start of the list
9.1 item with 1 tab
+2 item with 2 tabs
+2 item with 2 tabs
+1 item with 1 tab
10. item
Result:
- item
- item
- item with 1 tab
- item with 2 tabs
- item with 2 tabs
- item with 1 tab
- item with 1 tab
- item
In all list types, you can use as many spaces or tabs as you want between the list element (+, -, 1., 1.2, ...) and the text. MMX only cares about the number of leading characters that mark the indentation level.