Docs

Steps

Number a sequence the reader works through in order.

Open Markdown

Use steps for a procedure where order matters and each item is a thing the reader does. Numbering is generated, so inserting a step never renumbers the rest by hand.

content/setup.mdx
<Steps>
<Step>
Add the dependencies to `Cargo.toml`.
</Step>
<Step>
Write `build.rs` and call `proa_docs_build::compile`.
</Step>
<Step>
Include the registry with `include_docs!` and mount a route.
</Step>
</Steps>

Rendered:

Add the dependencies to Cargo.toml.

Write build.rs and call proa_docs_build::compile.

Include the registry with include_docs! and mount a route.

Neither tag takes attributes.

Steps nest: an inner <Steps> inside a <Step> opens its own numbering and closes back to the outer sequence.

When not to use it

Reach for an ordered list when the items are facts rather than actions. Steps carry visual weight that a three-item list does not earn, and a reader reads them as "do this now."

Good to know: Markdown inside a <Step> is rendered normally, so code fences, callouts, and tabs all work inside one.

Accordions · Tabs · Quickstart

Search

Type at least 2 characters