API Reference

Steps

An ordered sequence a reader or agent follows top to bottom — an install runbook or setup flow.

For an ordered sequence a reader (or agent) follows top to bottom — an install runbook, a setup flow, a migration. Wrap <Step> elements in <Steps>; each step takes a title.

When to use it

Use steps when order matters and each item is an action the reader performs in turn. If the items are alternatives rather than a sequence, reach for Tabs; if they're collapsible detail, reach for Accordions.

Props

ComponentPropTypeDescription
<Step>titleReactNodeThe step heading
<Step>childrenReactNodeWhat to do in this step

Live example

Install

Add the package: npm i superlore.

Wire the MDX map

Spread getMDXComponents() into your app.

Author a page

Write MDX and drop in components.

Confirm

Build, then open the page in both themes.

On this page

Built withsuperlore