Lists
DocsForge supports all standard list types plus extended syntax.
Unordered lists
- Item 1
- Item 2
- Item 3
- Item 1
- Item 2
- Item 3
Ordered lists
1. First item
2. Second item
3. Third item
- First item
- Second item
- Third item
Nested lists
- Parent item
- Child item 1
- Child item 2
- Grandchild item
- Another parent
- Parent item
- Child item 1
- Child item 2
- Grandchild item
- Another parent
Task lists
Enable with pymdownx.tasklist:
- [x] Completed task
- [ ] Incomplete task
- [ ] Another task
- Completed task
- Incomplete task
- Another task
Definition lists
Enable with def_list:
Term 1
: Definition of term 1
Term 2
: Definition of term 2
: Another definition for term 2
- Term 1
- Definition of term 1
- Term 2
- Definition of term 2
- Another definition for term 2
Fancy task lists
Custom checkbox styling is enabled by default:
markdown_extensions:
- pymdownx.tasklist:
custom_checkbox: true
This renders checkboxes with Material Design styling.
List with code blocks
Lists can contain code blocks:
1. First step
``` bash
echo "Hello"
```
2. Second step
``` bash
echo "World"
```
- First step
echo "Hello" - Second step
echo "World"
List with admonitions
- Item with a note
!!! note
Important detail about this item
- Another item
- Item with a note
!!! note
Important detail about this item - Another item