Steps

Numbered step-by-step guides

Last updated March 16, 2026

Steps

Display a numbered step-by-step guide with a visual timeline.

Usage

Use the steps code fence. Each # Title creates a numbered step.

```steps
# Install the package
Run the install command for your package manager.

# Create a config file
Add a `petit.config.json` to your project root.

# Start the dev server
Run `npx @ephem-sh/petit dev` and open the browser.
```

Example

1
Install the package

Run the install command for your preferred package manager.

2
Create a config file

Add a petit.config.json to your docs directory with your title and sidebar structure.

3
Write your docs

Create markdown files in the directories referenced by your sidebar config.

4
Start the dev server

Run npx @ephem-sh/petit dev and open your browser to see the docs.

API Reference

Step Properties
PropertyTypeDefaultDescription
titlestringrequiredStep heading (from `# Title` line)
contentstringrequiredStep description (supports inline markdown)

Search Documentation

Search for pages and content