Typemark Documentation

ステップ

番号付きのステップで手順を順に案内します。各ステップにはタイトルを付けられ、コードやコールアウトを含む任意のコンテンツを入れられます。

2026年11月19日更新

ステップは手順を番号付きの連続したシーケンスにし、番号同士を線でつなぎます。順序が重要な場合に使用してください。

  1. CLI をインストールする

    npm で Acme CLI をインストールします:

    npm install -g @acme/cli
  2. ログインする

    API キーで認証します:

    acme login --key sk_live_abc123
  3. プロジェクトを作成する

    acme init my-project

    これにより、初期設定を含む my-project フォルダーが作成されます。

<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 はステップに自動で番号を振るため、並べ替えても番号を手動で振り直す必要はありません。

リッチコンテンツ

ステップには、ページに置けるあらゆるコンテンツを入れられます。コードグループ、コールアウト、リスト、画像などです。

  1. データベースを作成する

    psql -U postgres -f schema.sql
    mysql -u root < schema.sql
  2. 環境変数を設定する

    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>

プロパティ

Steps

<Steps> にはプロパティがありません。内側に <Step> ブロックを配置します。

Step

プロパティ型デフォルト説明
titlestringなしステップ番号の横に表示される見出しです。

タグの間に書いたコンテンツが、そのステップの本文になります。

ステップを使うタイミング

コンテンツ使用するコンポーネント
セットアップガイド、チュートリアル、移行手順Steps
読者が選択する複数のオプションTabs
順序のない機能やリンクリストまたはカード
補足的な詳細や FAQAccordions

ビジュアルエディターでの操作

/ と入力して Steps を選ぶと、2 つのステップを含むブロックが挿入されます。ステップのタイトルをクリックして名前を変更し、本文に入力します。ステップの横にあるブロックハンドルを使うと、複製、移動、削除ができます。