The steps container transforms a standard Markdown ordered list into a numbered vertical timeline. It is designed for technical tutorials and sequential how-to guides.
Both ::: steps and :::steps (spaceless) work natively. Use whichever style you prefer.
Syntax Reference
::: steps
1. **Step Title**
Step description goes here.
2. **Next Step**
Continue the sequence.
:::
| Container | Description |
|---|---|
::: steps |
The parent container that transforms child ordered list items into a numbered timeline. |
1. |
Any standard Markdown ordered list item acts as a chronological step. Bold the first line of each item to create a clear title. |
Examples
Basic Workflow
A straightforward sequence for a common task.
::: steps
1. **Initialise Project**
Run `npx @docmd/core init` to scaffold your directory.
2. **Author Content**
Write your documentation using standard Markdown files.
3. **Build & Deploy**
Run `npx @docmd/core build` to generate your static site.
:::
Initialise Project
Runnpx @docmd/core initto scaffold your directory.Author Content
Write your documentation using standard Markdown files.Build & Deploy
Runnpx @docmd/core buildto generate your static site.
Steps with Rich Content
Each step can contain code blocks, callouts, and other nested containers.
::: steps
1. **Configure Environment**
Define your project variables in `docmd.config.json`.
::: callout tip
Use `defineConfig` to enable IDE autocompletion for all configuration keys.
:::
2. **Generate Production Build**
Execute the build command to generate a highly optimised static site.
```bash
npx @docmd/core build
```
3. **Deploy to Infrastructure**
Synchronise the `site/` directory with S3, Cloudflare Pages, or Vercel.
:::
Configure Environment
Define your project variables indocmd.config.json.Use
defineConfigto enable IDE autocompletion for all configuration keys.Generate Production Build
Execute the build command to generate a highly optimised static site.npx @docmd/core buildDeploy to Infrastructure
Synchronise thesite/directory with S3, Cloudflare Pages, or Vercel.
AI models interpret the steps container as a signal for Sequential Workflows. Always start each list item with a bolded title — this allows agents to reliably parse the objective of each step from the llms.txt context.
