Typemark Documentation

アコーディオン

読者がクリックして展開できるタイトルの奥に、任意の詳細を隠します。FAQ向けに複数をグループにまとめて重ねられます。

2026年11月19日更新

アコーディオンはタイトルを表示し、クリックされるまで内容を隠します。FAQやトラブルシューティングなど、多くの読者が読み飛ばしてよい詳細に使います。

ページではどのファイル形式を使えますか?

ページは .mdx または .md ファイルです。どちらもタイトルと説明をフロントマターで指定できます。

<Accordion title="Which file types can a page use?">
  Pages are `.mdx` or `.md` files. Both take frontmatter for the title and description.
</Accordion>

説明、アイコン、デフォルトで開く

description を追加すると、タイトルの下に小さいテキストの行を表示できます。icon を指定すると、その前に Heroicons のアイコンを表示します。defaultOpen を設定すると、アコーディオンが展開された状態で始まります。

トラブルシューティングリクエストが失敗したときの確認事項

まずステータスコードを確認してください。401 は API キーが未設定または誤っていることを意味します。

<Accordion title="Troubleshooting" description="What to check when a request fails" icon="wrench-screwdriver" defaultOpen>
  Check the status code first. A `401` means the API key is missing or wrong.
</Accordion>

アコーディオングループ

アコーディオンを <AccordionGroup> で囲むと、それぞれの間に区切り線を入れて1つの枠にまとめられます。FAQを整理するのに最適な方法です。

独自ドメインは使えますか?

はい。プロジェクト設定で追加し、cname.typemark.dev を指すCNAMEレコードを作成してください。

コンテンツをエクスポートできますか?

ページはGitリポジトリに保存されます。GitHubに接続すると、自分のアカウントにコピーを保持できます。

ビジュアルエディタはMDXを変更しますか?

勝手に変更することはありません。ブロックがないコンポーネントは読み取り専用のソースとして表示され、保存時には記述どおりそのまま書き戻されます。

<AccordionGroup>
  <Accordion title="Can I use my own domain?">
    Yes. Add it in your project settings, then create a CNAME record pointing to `cname.typemark.dev`.
  </Accordion>
  <Accordion title="Can I export my content?">
    Your pages live in a Git repository. Connect it to GitHub to keep a copy in your own account.
  </Accordion>
  <Accordion title="Does the visual editor change my MDX?">
    Not behind your back. Components it has no block for show as read-only source and save back exactly as written.
  </Accordion>
</AccordionGroup>

リッチコンテンツ

本文には、ページに置けるものなら何でも入れられます。コードブロックやコールアウトも含みます。

リクエストを認証するには?

Authorization ヘッダーにAPIキーを指定してください:

const response = await fetch("https://api.acme.com/data", {
  headers: { Authorization: "Bearer sk_live_abc123" },
});

プロパティ

Accordion

PropTypeDefaultDescription
titlestringnoneクリックできるヘッダーのテキスト。
descriptionstringnoneタイトルの下に表示される小さいテキスト行。
iconstringnoneタイトルの前に表示されるHeroiconsの名前。
defaultOpenbooleanfalseアコーディオンを展開された状態で開始します。

AccordionGroup

<AccordionGroup> はプロパティを取りません。内側に <Accordion> ブロックを配置してください。

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

/ と入力して Accordion を選択します。ヘッダーのタイトルを編集し、その下に内容を入力します。description や icon など、エディタに表示されないプロパティは、保存時に記述どおり維持されます。