MDXの基本とfrontmatter
このプロジェクトのMDXは、apps/libx-docs/src/content/config.ts
のスキーマに従います。最低限は title
が必須です。
最小frontmatter
---
title: "ページのタイトル"
---
よく使う項目一覧
description
: 検索やカードに表示される説明category
: サイドバー上のカテゴリ(未指定ならパスから推定)categoryOrder
: カテゴリ列の順序(小さいほど上)order
: カテゴリ内の並び順(小さいほど上)prev
/next
: 手動の前後ページtags
: 任意のタグ配列draft
: 下書きフラグlicenseSource
/customAttribution
/hideAttribution
: ライセンス表記
---
title: "ページ"
description: "説明文"
order: 2
prev:
text: "前へ"
link: "/v1/ja/01-guide/03-create-and-edit-docs"
next:
text: "次へ"
link: "/v1/ja/01-guide/05-ui-components"
---
コンポーネントを使う
import { Alert, Icon } from '@docs/ui';
<Alert type="info">
<Icon name="info" /> 共有UIはMDXから直接呼べます。
</Alert>
次は「共有UIコンポーネント」へ。