Steps
Steps wraps a set of Step children in an ordered list styled with a left-rail and centered numbered badges. Use it for install / setup / migration guides where the reader is meant to work top-to-bottom.
Basic use
- Install the CLI
dotnet tool install -g ShellDocs.CLI --prerelease - Scaffold
shelldocs init MyDocs: producesdocs/MyDocs.Docs/with a working site. - Run
shelldocs dev: hot-reload on.md,.razor,.csedits.
<Steps>
<Step Title="Install the CLI">
`dotnet tool install -g ShellDocs.CLI --prerelease`
</Step>
<Step Title="Scaffold">
`shelldocs init MyDocs` : produces `docs/MyDocs.Docs/` with a working site.
</Step>
<Step Title="Run">
`shelldocs dev` : hot-reload on `.md`, `.razor`, `.cs` edits.
</Step>
</Steps>Titleless steps
Title is optional : drop it for a bare numbered bullet.
Fetch the changes.
Run the migration.
Verify the output.
<Steps>
<Step>Fetch the changes.</Step>
<Step>Run the migration.</Step>
<Step>Verify the output.</Step>
</Steps>Rich step bodies
Step children can contain any markdown : code blocks, callouts, nested components. The rail extends through the full body.
<Steps>
<Step Title="Add the package">
csharp
builder.Services.AddShellDocs();
Verify
Nested primitives work
Callouts, cards, code groups : anything you can use in top-level prose also works inside a Step.
Props
Steps
| Prop | Type | Default | Description |
|---|---|---|---|
| No props documented. | |||
Step
| Prop | Type | Default | Description |
|---|---|---|---|
Title |
string? |
— |
Optional title, rendered next to the numbered badge. |
ChildContent |
RenderFragment? |
— |
Step body. Supports full markdown when authored in a `.md` file. |
When to use
- Multi-step install / setup instructions
- Migration guides
- "Here's what to do next" walk-throughs where each step depends on the previous
When not to use
- Independent bullet list : use
-or* - Cross-referencing a decision matrix : use
TypeTable - One or two items : plain prose reads better than ceremony