Typemark Documentation

Steps

Walk readers through a process with numbered steps. Each step has a title and can hold any content, including code and callouts.

Actualizado el 19 nov 2026

Steps turn a procedure into a numbered sequence, with a line connecting each number to the next. Use them when the order matters.

  1. Install the CLI

    Install the Acme CLI with npm:

    npm install -g @acme/cli
  2. Log in

    Authenticate with your API key:

    acme login --key sk_live_abc123
  3. Create a project

    acme init my-project

    This creates a my-project folder with a starter config.

<Steps>
  <Step title="Install the CLI">
    Install the Acme CLI with npm:

    ```bash
    npm install -g @acme/cli
    ```
  </Step>
  <Step title="Log in">
    Authenticate with your API key:

    ```bash
    acme login --key sk_live_abc123
    ```
  </Step>
  <Step title="Create a project">
    ```bash
    acme init my-project
    ```

    This creates a `my-project` folder with a starter config.
  </Step>
</Steps>

Typemark numbers the steps for you, so you can reorder them without renumbering anything.

Rich content

A step can hold anything a page can: code groups, callouts, lists, images.

  1. Create the database

    psql -U postgres -f schema.sql
    mysql -u root < schema.sql
  2. Set your environment variables

    cp .env.example .env
<Steps>
  <Step title="Create the database">
    <CodeGroup>
      ```bash PostgreSQL
      psql -U postgres -f schema.sql
      ```
      ```bash MySQL
      mysql -u root < schema.sql
      ```
    </CodeGroup>
  </Step>
  <Step title="Set your environment variables">
    ```bash
    cp .env.example .env
    ```

    <Callout type="warning">
      Don't commit `.env`. It holds your credentials.
    </Callout>
  </Step>
</Steps>

Props

Steps

<Steps> takes no props. Put <Step> blocks inside it.

Step

PropTypeDefaultDescription
titlestringnoneHeading shown next to the step number.

The content between the tags is the step's body.

When to use steps

ContentUse
Setup guides, tutorials, migrationsSteps
Options the reader picks betweenTabs
Unordered features or linksA list or cards
Optional detail and FAQsAccordions

In the visual editor

Type / and pick Steps to insert a block with two steps. Click a step's title to rename it, and type in its body. Use the block handle beside a step to duplicate, move, or delete it.