Skip to content
Writing Documentation

Steps

Guide readers through a procedure one step at a time.

Use Steps for a procedure readers follow in order. The card shows one step at a time, with progress bars across the top. Select Next or Previous to move through the procedure.

Example

Step 1 of 3

Create a page

Add a Markdown file to a category in docs/.

Markdown syntax

In an .md or .mdx file, open the block with :::steps and close it with :::. Start each step with ### and a title. Its content continues until the next step title or the closing fence.

md
:::steps

### Create a page

Add a Markdown file to a category in `docs/`.

### Preview your changes

Open the new page in your browser while the development server is running.

### Check the links

Follow the [relative links](./document-links.mdx) on the page to verify that
they lead to the intended documents.

:::

Nest other components

Steps can contain paragraphs, lists, links, code blocks, and other Markdown components. To nest Tabs, use four colons for the outer ::::steps fence and three for the inner :::tabs fence. Close each block with the same number of colons you used to open it.

Step 1 of 2

Start the development server

pnpm dev