Skip to main content
Starlight

Search documentation

Type to search this documentation.

On this pageOverview

Steps

To style a numbered list of tasks to create step-by-step guides, use the <Steps> component.

  1. Create a new Starlight project:

    Shell
    npm create astro@latest -- --template starlight
    Shell
    pnpm create astro --template starlight
    Shell
    yarn create astro --template starlight
  2. Write your first documentation page.

TSX
import { Steps } from '@astrojs/starlight/components';

Use the <Steps> component to style numbered lists of tasks. This is useful for more complex step-by-step guides where each step needs to be clearly highlighted.

Wrap <Steps> around a standard Markdown ordered list. All the usual Markdown syntax is applicable inside <Steps>.

MDX
import { Steps } from '@astrojs/starlight/components';

<Steps>

1. Import the component into your MDX file:

   ```js
   import { Steps } from '@astrojs/starlight/components';
   ```

2. Wrap `<Steps>` around your ordered list items.

</Steps>
markdoc
{% steps %}

1. Import the component into your MDX file:

   ```js
   import { Steps } from '@astrojs/starlight/components';
   ```

2. Wrap `<Steps>` around your ordered list items.

{% /steps %}
  1. Import the component into your MDX file:

    JavaScript
    import { Steps } from '@astrojs/starlight/components';
  2. Wrap <Steps> around your ordered list items.

Implementation: Steps.astro

The <Steps> component does not accept any props.

Suggest an edit

Propose a replacement for this page. The site team reviews it before applying any changes.

Export
Documentation menu