Steps

Numbered step-by-step guides

Steps provide a numbered sequence for tutorials and guides.

Basic Steps

1
Install the package
npm install @jamdesk/cli
2
Initialize your project
jamdesk init
3
Start the dev server
jamdesk dev

Steps Without Titles

Steps work without titles too:

Clone the repository from GitHub.

Install dependencies with npm install.

Run the development server.

Rich Content in Steps

Each step can contain any content:

1
Configure your API

Create a configuration file:

title="config.json"
{
  "apiKey": "your-api-key",
  "endpoint": "https://api.example.com"
}

Keep your API key secret! Never commit it to version control.

2
Make your first request

Use the SDK to make a request:

const response = await client.getData();
console.log(response);

Props

Step

PropTypeDescription
titlestringOptional step title
stepNumbernumberAuto-assigned by Steps container

Was this page helpful?