Components · Content
Steps
A numbered how-to or runbook. Each item has a title, an optional body in Markdown, and optional code (with language) to copy and run.
ExamplesLink to this section
Set up a local copy
Step 1: Install dependencies
Use pnpm. The lockfile is checked in.
sh pnpm install --frozen-lockfileStep 2: Set the environment
Copy
.env.exampleto.env.localand fill inDATABASE_URL.Step 3: Run the migrations
sh pnpm db:migrateStep 4: Start the app
sh pnpm dev
Show JSONHide JSON
{
"version": 1,
"root": "steps",
"elements": {
"steps": {
"type": "Steps",
"props": {
"title": "Set up a local copy",
"items": [
{
"title": "Install dependencies",
"body": "Use **pnpm**. The lockfile is checked in.",
"code": "pnpm install --frozen-lockfile",
"language": "sh"
},
{
"title": "Set the environment",
"body": "Copy `.env.example` to `.env.local` and fill in `DATABASE_URL`."
},
{
"title": "Run the migrations",
"code": "pnpm db:migrate",
"language": "sh"
},
{
"title": "Start the app",
"code": "pnpm dev",
"language": "sh"
}
]
}
}
}
}PropsLink to this section
Generated from the zod schema the server validates with. Unknown props are ignored with a warning. Any prop can also be a dynamic value such as { "$state": "/path" }; it is checked again once it resolves.
| Prop | Type | Limits and defaults |
|---|---|---|
| itemsrequired | object[] | max 50 items |
| items[].titlerequired | string | max 160 chars |
| items[].body | string | max 5,000 chars |
| items[].code | string | max 10,000 chars |
| items[].language | string | max 40 chars |
| title | string | max 160 chars |
RulesLink to this section
bodyis Markdown.codegets a copy button.
Children and eventsLink to this section
Steps is a leaf: it does not show children. Validation warns when a leaf has some; wrap them in a Stack or Card instead.
It emits no events.