/Docs
Search docs or ask a question⌘K
DocsAgent
Changelog

Steps

Step-by-step instructions for tutorials and guides.

3 min read

The Steps component creates numbered, visually connected step-by-step instructions. Perfect for tutorials, setup guides, and multi-step processes.

On doc engine v1 sites, every step with a title is collapsible and starts collapsed — readers see the numbered step titles at a glance and click a title to expand its body. Steps without a title render expanded and are not collapsible. On doc engine v2, every step is shown expanded and is not collapsible. This behavior applies to the Steps component directly; it is separate from the Expandable component.

Basic Steps

mdx
<Steps>
<Step title="Install the CLI">
Download and install the Syntext CLI:
```bash
curl -fsSL https://get.syntext.dev | sh
```
</Step>
<Step title="Initialize your project">
Create a new documentation project:
```bash
stx init --name "My Docs"
```
</Step>
<Step title="Start a live preview">
Deploy a preview that updates on every save:
```bash
stx dev
```
</Step>
</Steps>
  1. 01Step 1 of 31 ›Step 11.
    Install the CLI

    Download and install the Syntext CLI:

    bash
    curl -fsSL https://get.syntext.dev | sh
  2. 02Step 2 of 32 ›Step 22.
    Initialize your project

    Create a new documentation project:

    bash
    stx init --name "My Docs"
  3. 03Step 3 of 33 ›Step 33.
    Start a live preview

    Deploy a preview that updates on every save:

    bash
    stx dev

With Rich Content

Steps can contain any markdown or components:

mdx
<Steps>
<Step title="Create an account">
Visit [app.syntext.dev/register](https://app.syntext.dev/register) and create your account.
<Note>
Use your company email for team features.
</Note>
</Step>
<Step title="Choose a template">
Select from available templates:
<CardGroup cols={2}>
<Card title="API Docs" href="/templates/api">For REST APIs</Card>
<Card title="SDK Docs" href="/templates/sdk">For libraries</Card>
</CardGroup>
</Step>
</Steps>
  1. 01Step 1 of 21 ›Step 11.
    Create an account

    Visit app.syntext.dev/register and create your account.

    Note

    Use your company email for team features.

  2. 02Step 2 of 22 ›Step 22.
    Choose a template

    Select from available templates:

    API Docs
    For REST APIs
    SDK Docs
    For libraries

With Icons

Add icons to steps:

mdx
<Steps>
<Step title="Download" icon="download">
Download the installer for your platform.
</Step>
<Step title="Configure" icon="settings">
Set up your configuration file.
</Step>
<Step title="Deploy" icon="rocket">
Push to production.
</Step>
</Steps>
  1. 01Step 1 of 31 ›Step 11.
    Download

    Download the installer for your platform.

  2. 02Step 2 of 32 ›Step 22.
    Configure

    Set up your configuration file.

  3. 03Step 3 of 33 ›Step 33.
    Deploy

    Push to production.

Compact Steps

For simpler instructions:

mdx
<Steps>
<Step title="Clone the repository" />
<Step title="Install dependencies with `npm install`" />
<Step title="Run `npm start` to launch" />
</Steps>
  1. 01Step 1 of 31 ›Step 11.
    Clone the repository
  2. 02Step 2 of 32 ›Step 22.
    Install dependencies with `npm install`
  3. 03Step 3 of 33 ›Step 33.
    Run `npm start` to launch

Step Props

PropTypeDescription
titlestringStep heading. Optional — without it the step is always expanded
iconstringOptional icon — a name from the icon set (drawn on doc engine v1 and v2; an unknown name draws nothing)
hrefstringInside a <QuickStart> only (doc engine v2): the page the step links to
childrenReactNodeStep content

Steps Props

PropTypeDefaultDescription
titleSizestring"md"Title size: "sm", "md", "lg"
childrenStep[]—Step components

Best Practices

Tip

Keep steps focused on a single action. If a step requires many sub-actions, consider breaking it into multiple steps.

•
Use clear, action-oriented titles
•
Include code examples where relevant
•
Keep content within each step concise
•
Number steps automatically — don't add manual numbers
•
Test that the steps actually work in order
Was this page helpful? Yes No
Previous
Product
Resources
Company
© 2026 SyntextBuilt with Syntext