Steps
Numbered Markdown lists render automatically as a Steps timeline — numbered badges joined by a vertical line, each beside its step's content. No special syntax.
Write an ordinary numbered list in Markdown and aardvark renders it as a
Steps block: a vertical run of numbered badges joined by a connecting line,
each badge beside that step’s content, built from Mantine’s Timeline. There’s
no tag to learn — a plain 1. … 2. … 3. list is all it takes. Each step’s
body is full Markdown: paragraphs, code, images, even nested lists.
Usage
Just write the list:
1. **Install** — pull in the toolchain with `npm install`.
2. **Configure** — add an `aardvark.config.yaml` and point `content` at your Markdown.
3. **Build** — run `vark build`, then serve the `build/` directory.
renders, live:
npm install.aardvark.config.yaml and point content at your Markdown.vark build, then serve the build/ directory.npm install.aardvark.config.yaml and point content at your Markdown.vark build, then serve the build/ directory.Lead each step with a bold phrase to give it a title, or just write prose — both read well beside the number.
Multi-block steps
A step can hold any block content — extra paragraphs, a code block, an image. Leave a blank line between items (a “loose” list) and give each step as much room as it needs:
1. Create the config.
```yaml
site:
name: My Docs
```
2. Add your first page at `content/index.md`.
3. Build and serve.
Create the config.
site:
name: My Docs
Add your first page at content/index.md.
Build and serve.
Create the config.
site:
name: My Docs
Add your first page at content/index.md.
Build and serve.
Numbering
The list’s own numbering is kept, so a list that starts at 3 shows 3, 4, 5:
3. Third
4. Fourth
5. Fifth
Nested numbered lists
With Steps on, a nested numbered list flattens into the step body rather than forming its own timeline:
- A nested numbered list stays a plain ordered list…
- …sitting inside the step body, which can look out of place.
- A nested numbered list stays a plain ordered list…
- …sitting inside the step body, which can look out of place.
Bullet lists are never Steps, at any level.
Turning it off
Auto-Steps is on by default. To render numbered lists as plain ordered lists
site-wide, set steps: false in aardvark.config.yaml:
# Render numbered lists as plain <ol> instead of Steps.
steps: false