WritedocsWritedocs

Steps and Step

View as MarkdownView this page as plain textOpen in ChatGPTAsk questions about this pageOpen in ClaudeAsk questions about this pageOpen in PerplexityAsk questions about this page
Connect to CursorUse these docs in CursorConnect to VS CodeUse these docs in VS Code

Write

Create or edit an .mdx file under docs/.

Preview

Run writedocs dev and check the change in your browser.

Ship

Push your changes — build and deploy are handled from there.

<Steps>
  <Step title="Write">
    Create or edit an `.mdx` file under `docs/`.
  </Step>
  <Step title="Preview">
    Run `writedocs dev` and check the change in your browser.
  </Step>
</Steps>

Step props

titlestring

An untitled step just renders its content without a bold heading line above it.

iconstring

Shown in the step’s circle instead of its number. Later steps keep counting as if the number were there.

stepNumbernumber

Sets this step’s number. The steps after it continue from it.

titleSize"p" | "h2" | "h3"default: "p"

Renders the title as an h2 or h3 instead of bold text.

Steps itself takes no props — it’s a plain wrapper that numbers and connects its Step children.