Steps
Numbered step-by-step guides
Steps provide a numbered sequence for tutorials and guides.
Basic Steps
npm install @jamdesk/clijamdesk initjamdesk dev<Steps>
<Step title="Install the package">
```bash
npm install @jamdesk/cli
```
</Step>
<Step title="Initialize your project">
```bash
jamdesk init
```
</Step>
<Step title="Start the dev server">
```bash
jamdesk dev
```
</Step>
</Steps>
Steps Without Titles
Steps work without titles too:
Clone the repository from GitHub.
Install dependencies with npm install.
Run the development server.
<Steps>
<Step>
Clone the repository from GitHub.
</Step>
<Step>
Install dependencies with `npm install`.
</Step>
<Step>
Run the development server.
</Step>
</Steps>
Rich Content in Steps
Each step can contain any content:
Create a configuration file:
{
"apiKey": "your-api-key",
"endpoint": "https://api.example.com"
}Keep your API key secret! Never commit it to version control.
Use the SDK to make a request:
const response = await client.getData();
console.log(response);Steps with Icons
Use icons instead of numbers for visual variety:
Clone from GitHub to your local machine.
Run the package manager install command.
Launch the development server.
<Steps>
<Step title="Clone the repository" icon="code-branch">
Clone from GitHub to your local machine.
</Step>
<Step title="Install dependencies" icon="download">
Run the package manager install command.
</Step>
<Step title="Start developing" icon="rocket">
Launch the development server.
</Step>
</Steps>
Title Size
Control the heading hierarchy with titleSize on the Steps container:
First Step
This title renders as an h3 element.
Second Step
Useful for SEO and document structure.
<Steps titleSize="h3">
<Step title="First Step">
This title renders as an h3 element.
</Step>
<Step title="Second Step">
Useful for SEO and document structure.
</Step>
</Steps>
Properties
Steps
p | h2 | h3default: pHeading element for step titles.
Step
stringOptional step title.
stringIcon name, URL, or path (replaces step number).
solid | regular | light | thin | sharp-solid | duotone | brandsdefault: solidFont Awesome icon style.
p | h2 | h3Override the parent Steps titleSize. Inherits from parent if not set.
numberManually set step number (auto-assigned if omitted).
