Steps
Step-by-step instructions for tutorials and guides.
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
- 01Step 1 of 31 ›Step 11.Install the CLI
Download and install the Syntext CLI:
bashcurl -fsSL https://get.syntext.dev | sh - 02Step 2 of 32 ›Step 22.Initialize your project
Create a new documentation project:
bashstx init --name "My Docs" - 03Step 3 of 33 ›Step 33.Start a live preview
Deploy a preview that updates on every save:
bashstx dev
With Rich Content
Steps can contain any markdown or components:
- 01Step 1 of 21 ›Step 11.Create an account
Visit app.syntext.dev/register and create your account.
NoteUse your company email for team features.
- 02Step 2 of 22 ›Step 22.Choose a template
Select from available templates:
API DocsFor REST APIsSDK DocsFor libraries
With Icons
Add icons to steps:
- 01Step 1 of 31 ›Step 11.Download
Download the installer for your platform.
- 02Step 2 of 32 ›Step 22.Configure
Set up your configuration file.
- 03Step 3 of 33 ›Step 33.Deploy
Push to production.
Compact Steps
For simpler instructions:
- 01Step 1 of 31 ›Step 11.Clone the repository
- 02Step 2 of 32 ›Step 22.Install dependencies with `npm install`
- 03Step 3 of 33 ›Step 33.Run `npm start` to launch
Step Props
| Prop | Type | Description |
|---|---|---|
title | string | Step heading. Optional — without it the step is always expanded |
icon | string | Optional icon — a name from the icon set (drawn on doc engine v1 and v2; an unknown name draws nothing) |
href | string | Inside a <QuickStart> only (doc engine v2): the page the step links to |
children | ReactNode | Step content |
Steps Props
| Prop | Type | Default | Description |
|---|---|---|---|
titleSize | string | "md" | Title size: "sm", "md", "lg" |
children | Step[] | — | Step components |
Best Practices
Keep steps focused on a single action. If a step requires many sub-actions, consider breaking it into multiple steps.