zudo-docのすべてのMDXファイルは`---`で区切られたYAMLフロントマターブロックで始まります。このページでは利用可能なすべてのフィールドを説明します。 ## 完全な例 ```mdx --- title: My Documentation Page description: A comprehensive guide to something important. sidebar_position: 3 sidebar_label: My Page tags: [type:tutorial, setup] --- Your content here. ``` ## 最小限の例 必須なのは`title`のみです： ```mdx --- title: Quick Start --- ``` ## フィールド一覧 | フィールド | 型 | 必須 | デフォルト | 説明 | |-------|------|----------|---------|-------------| | `title` | string | はい | -- | ページタイトル。見出し、サイドバー、ブラウザタブに表示 | | `description` | string | いいえ | -- | タイトル下に表示されるサブタイトル | | `sidebar_position` | number | いいえ | `999` | サイドバーカテゴリ内のソート順 | | `sidebar_label` | string | いいえ | `title`の値 | サイドバーに表示されるラベルのオーバーライド | | `sidebar_initial_expansion` | `"collapsed"`または`"expanded"` | いいえ | 継承値、未設定時は従来の動作 | サイドバーの初期展開状態。カテゴリのインデックスから配下に継承 | | `category` | string | いいえ | ディレクトリ名 | 将来の使用のために予約 | | `category_no_page` | boolean | いいえ | `false` | カテゴリをリンクなしのヘッダーにする（ルート・サイトマップ・検索エントリなし） | | `category_sort_order` | `"asc" \| "desc"` | いいえ | `"asc"` | カテゴリ内ページのソート順 | | `category_shape` | `"note-tray"` | いいえ | 通常のツリー | トップレベルのフラットなカテゴリをノートトレイにする | | `note_tray_dated` | boolean | いいえ | `false` | ノートトレイの全アイテムに`date`を必須化 | | `note_tray_sidebar` | `"index" \| "year" \| "month"` | いいえ | `"index"` | ノートトレイのサイドバー表示を選択 | | `date` | `"YYYY-MM-DD"` | いいえ | — | ドキュメントの日付。日付付きノートトレイのアイテムでは必須 | | `updated` | `"YYYY-MM-DD"` | いいえ | — | どのドキュメントにも指定できる任意の更新日 | | `search_exclude` | boolean | いいえ | `false` | ページを検索インデックスから除外 | | `tags` | string[] | いいえ | -- | 横断的なナビゲーション用タグ | | `draft` | boolean | いいえ | `false` | 本番ビルドから除外（開発時は表示） | | `unlisted` | boolean | いいえ | `false` | ビルドされるがサイドバー、検索、検索エンジンから非表示 | | `hide_sidebar` | boolean | いいえ | `false` | 左サイドバーを非表示にし、コンテンツを狭いコンテナに中央揃え | | `hide_toc` | boolean | いいえ | `false` | 右側の目次を非表示 | | `wide` | boolean | いいえ | `false` | コンテンツバンドを広げてビューポートの大部分を埋める（全幅レイアウト） | | `doc_history` | boolean | いいえ | 自動 | doc-historyボタンの表示を上書き（自動：`*/index`ページは非表示、詳細ページは表示） | | `standalone` | boolean | いいえ | `false` | サイドバーナビゲーションから非表示だがインデックスされる（`unlisted`とは異なる） | | `slug` | string | いいえ | ファイルパスから導出 | カスタムURLスラグのオーバーライド | | `generated` | boolean | いいえ | `false` | ビルド時に自動生成されたコンテンツであることを示す。設定済みロケールの翻訳要件から除外される | | `pagination_next` | string \| null | いいえ | 自動 | 次のページリンクをオーバーライド、`null`で非表示 | | `pagination_prev` | string \| null | いいえ | 自動 | 前のページリンクをオーバーライド、`null`で非表示 | ## フィールド詳細 ### `title` - **型：** `string` - **必須：** はい ページタイトル。ページの`h1`見出し、サイドバーナビゲーション、ブラウザタブ、検索結果に表示されます。 ```mdx --- title: Getting Started with zudo-doc --- ``` ### `description` - **型：** `string` - **必須：** いいえ ページの短い説明またはサブタイトル。レンダリングされたページでタイトルの下に表示されます。SEOメタタグにも使用されます。 ```mdx --- title: Installation description: How to install and set up zudo-doc for your project. --- ``` ### `sidebar_position` - **型：** `number` - **必須：** いいえ - **デフォルト：** `999`（末尾に表示） サイドバーカテゴリ内のページのソート順を制御します。小さい数値ほど先に表示されます。 ```mdx --- title: Introduction sidebar_position: 1 --- ``` [Dynamic content unavailable in text export] カテゴリインデックスページ（`index.mdx`）では、`sidebar_position`はカテゴリ全体がサイドバー内の他のカテゴリに対してどこに表示されるかも制御します。 ### `sidebar_label` - **型：** `string` - **必須：** いいえ - **デフォルト：** `title`の値 サイドバーナビゲーションに表示されるラベルをオーバーライドします。完全なページタイトルよりも短い、または異なるラベルを表示したい場合に使用します。 ```mdx --- title: Configuring Color Schemes and Themes sidebar_label: Color Schemes --- ``` ### `category` - **型：** `string` - **必須：** いいえ - **デフォルト：** ディレクトリ構造から導出（最初のディレクトリセグメント） 将来の使用のために予約されています。このフィールドはコンテンツスキーマで定義されていますが、現在はサイドバーやルーティングロジックでは使用されていません。カテゴリは常にディレクトリ構造から導出されます。 [Dynamic content unavailable in text export] ページをカテゴリに整理するには、`src/content/docs/`の下にディレクトリを作成してその中に配置します。ディレクトリ名がカテゴリ名になります。 ### `category_no_page` - **型：** `boolean` - **必須：** いいえ - **デフォルト：** `false` カテゴリの`index.mdx`に設定すると、サイドバーでそのカテゴリがリンクなしのヘッダーとして表示されます。インデックスページ自体のルート・サイトマップエントリ・検索エントリは生成されず、配下のページをラベル付けしてグループ化するためだけに存在します。 ```mdx --- title: Internals category_no_page: true sidebar_position: 10 --- ``` ### `category_sort_order` - **型：** `string` - **必須：** いいえ - **デフォルト：** — （`sidebar_position`の昇順） カテゴリの`index.mdx`に設定すると、そのカテゴリ内ページのデフォルトの昇順ソートをオーバーライドします。`"desc"`を設定すると新しい順（降順）になります。最新のエントリを先頭に表示したい変更履歴やリリースノートのカテゴリに便利です。 ```mdx --- title: Changelog category_sort_order: "desc" sidebar_position: 20 --- ``` ノートトレイでは、サイドバー、`NoteTrayIndex`、前・次ページャー、ホームページのすべてでこの順序が使われます。詳しくは[ノートトレイ](https://zudo-doc.takazudomodular.com/ja/docs/guides/note-tray)を参照してください。 ### `category_shape` - **型：** `"note-tray"` - **必須：** No - **デフォルト：** 通常のツリーカテゴリ トップレベルカテゴリの`index.mdx`に`category_shape: "note-tray"`を設定すると、直下の子ファイルがフラットな順序付きページ列になります。ノートトレイには表示されるルート付きindexが必要で、子ディレクトリは置けません。 ```mdx --- title: Notes sidebar_position: 3 category_shape: "note-tray" --- ``` ### `note_tray_dated` - **型：** `boolean` - **必須：** No - **デフォルト：** `false` ノートトレイのindexで`true`にすると、`unlisted`を含むトレイ内の全アイテムに`date`が必要です。ビルドは問題のあるslugをすべて報告します。 ### `note_tray_sidebar` - **型：** `"index" | "year" | "month"` - **必須：** No - **デフォルト：** `"index"` ノートトレイのサイドバー表示を選びます。`index`は安定したrankを表示し、`year`と`month`はアイテムを時系列でグループ化します。後者2つには`note_tray_dated: true`が必要です。 ### `date` - **型：** `"YYYY-MM-DD"` - **必須：** 日付付きノートトレイの全アイテムで必須 ドキュメントの日付を設定します。zfbは引用符の有無にかかわらずスカラー値を文字列として保持するため、引用符は任意です。スキーマが`YYYY-MM-DD`形式を検証し、ビルドが暦上存在しない日付を拒否します。このフィールドを利用する別のYAML 1.1ツール（js-yamlなど）が、引用符のない日付を`Date`オブジェクトに変換する場合に限り、相互運用性のために引用符を付けてください。 `date`と`updated`の**記述**形式は、[`dateFormat`](https://zudo-doc.takazudomodular.com/ja/docs/guides/configuration#%E3%82%B3%E3%83%B3%E3%83%86%E3%83%B3%E3%83%84%E3%81%A8-i18n-dateformat)の設定にかかわらず常に`YYYY-MM-DD`です。`dateFormat`が変えるのは表示のされ方だけで、スキーマはフロントマターの生の値を`YYYY-MM-DD`として厳密に検証します。 ```mdx --- title: Project Note sidebar_position: 1 date: "2026-08-20" --- ``` ### `updated` - **型：** `"YYYY-MM-DD"` - **必須：** No どのドキュメントにも任意の更新日を設定できます。ドキュメントヘッダーでは`date`の隣に表示され、日付を表示するノートトレイのインデックスとホームページにも表示されます。`date`がなくても単独で表示できます。サイドバーとページャーには`updated`を表示しません。 ### `search_exclude` - **型：** `boolean` - **必須：** いいえ - **デフォルト：** `false` `true`に設定すると、ページを検索インデックスから除外します。検索結果に表示すべきでない内部ページ、変更履歴、インポートされたコンテンツに便利です。 ```mdx --- title: Internal Changelog search_exclude: true --- ``` ### `tags` - **型：** `string[]` - **必須：** いいえ 横断的なナビゲーション用のタグをページに割り当てます。タグはページにクリック可能なバッジとして表示され、タグインデックスページが`/docs/tags/`と`/docs/tags/[tag]`に自動生成されます。 詳しい使い方は[タグガイド](https://zudo-doc.takazudomodular.com/ja/docs/guides/tags)を参照してください。 タグ付きページは3か所に表示されます： 1. **各ドキュメントの下部** — タグ付きページの前/次ページャーの直上に、タグバッジの行が表示されます。 2. **ホームページ** — ドキュメントで使用されているすべてのタグを一覧表示する「All tags」セクションがあり、各タグのインデックスページへリンクします。 3. **タグインデックス** — [/docs/tags/](/docs/tags/) の共有インデックスで、タグごとにすべてのページをグループ化して表示します。 ```mdx --- title: Deploying to Netlify tags: [deployment, netlify, hosting] --- ``` [Dynamic content unavailable in text export] タグは、異なるサイドバーカテゴリにまたがる関連ページをグループ化するのに便利です。 ### `draft` - **型：** `boolean` - **必須：** いいえ - **デフォルト：** `false` `true`に設定すると、ページは本番ビルドから完全に除外されます。下書きページはプレビュー目的で開発時（`pnpm dev`）には引き続き表示されます。 ```mdx --- title: Upcoming Feature draft: true --- ``` ### `unlisted` - **型：** `boolean` - **必須：** いいえ - **デフォルト：** `false` `true`に設定すると、ページはビルドされてURL経由でアクセス可能ですが、サイドバーナビゲーション、検索インデックス、検索エンジン（`noindex`メタタグ経由）からは非表示になります。 ```mdx --- title: Internal Notes unlisted: true --- ``` ### `hide_sidebar` - **型：** `boolean` - **必須：** いいえ - **デフォルト：** `false` `true`に設定すると、デスクトップで左側のサイドバーが非表示になり、コンテンツが狭いコンテナに中央揃えで表示されます。モバイルのハンバーガーメニューからは引き続きナビゲーションにアクセスできます。ランディングページ、スタンドアロンの記事、フルワイドの読書体験が望ましいページに便利です。 ```mdx --- title: About This Project hide_sidebar: true --- ``` [Dynamic content unavailable in text export] [ライブデモ](https://zudo-doc.takazudomodular.com/ja/docs/guides/layout-demos/hide-sidebar)でこのレイアウトオプションを実際に確認できます。 ### `hide_toc` - **型：** `boolean` - **必須：** いいえ - **デフォルト：** `false` `true`に設定すると、右側の目次（セクションナビゲーション）とモバイルの目次の両方が非表示になります。メインコンテンツエリアが利用可能な幅いっぱいに広がります。 ```mdx --- title: Changelog hide_toc: true --- ``` [Dynamic content unavailable in text export] [ライブデモ](https://zudo-doc.takazudomodular.com/ja/docs/guides/layout-demos/hide-toc)でこのレイアウトオプションを実際に確認できます。 [Dynamic content unavailable in text export] `hide_sidebar`と`hide_toc`を組み合わせて、ナビゲーションパネルのないクリーンでセンタリングされた読みやすいレイアウトを作成できます： ```mdx --- title: About hide_sidebar: true hide_toc: true --- ``` 両方のオプションを組み合わせた[ライブデモ](https://zudo-doc.takazudomodular.com/ja/docs/guides/layout-demos/hide-both)もご覧ください。 ### `wide` - **型：** `boolean` - **必須：** いいえ - **デフォルト：** `false` `true`に設定すると、コンテンツバンドが標準の読書幅の上限ではなく、ビューポートの大部分を埋めるように広がります。グリッド中心のページやダッシュボード的なページ（たとえばカテゴリーグリッドを全幅に広げたほうが読みやすいトップページなど）に適しています。`hide_sidebar`と自然に組み合わせられます。`hide_sidebar`ページではコンテンツが通常は固定の読書幅で中央揃えされますが、`wide: true`を加えるとそのコンテンツがビューポート全体に広がります。 ```mdx --- title: Overview hide_sidebar: true wide: true --- ``` [Dynamic content unavailable in text export] このレイアウトオプションの動作は[ライブデモ](https://zudo-doc.takazudomodular.com/ja/docs/guides/layout-demos/wide)でご確認いただけます。 ### `standalone` - **型：** `boolean` - **必須：** いいえ - **デフォルト：** `false` `true`に設定すると、ページはサイドバーナビゲーションとサイトインデックスから非表示になりますが、URL経由でアクセス可能で検索エンジンにインデックスされます。`unlisted`とは異なり、standaloneページには`noindex`メタタグが付きません。また、サイドバーと目次のクロームなしでレンダリングされます。これは`hide_sidebar: true`と`hide_toc: true`を同時に指定した場合と同等です。 ```mdx --- title: Terms of Service standalone: true --- ``` [Dynamic content unavailable in text export] 公開アクセス可能であるべきだがドキュメントナビゲーションには含めたくないページ（利用規約、特別なランディングページなど）には`standalone`を使用します。検索エンジンのインデックスも防ぎたい場合は`unlisted`を使用します。 ### `slug` - **型：** `string` - **必須：** いいえ - **デフォルト：** ファイルパスから導出 ページのURLスラグをオーバーライドします。ファイルパスから生成されるURLとは異なるURLにしたい場合に使用します。 ```mdx --- title: Getting Started with zudo-doc slug: quickstart --- ``` このページはファイルの場所から導出されるデフォルトパスの代わりに`/docs/quickstart`でアクセスできるようになります。 ### `generated` - **型：** `boolean` - **必須：** いいえ - **デフォルト：** `false` ページがビルド時に自動生成されたコンテンツであること（例：`.claude/`ソースファイルから生成される`claude-*`リファレンスページ）を示します。`generated: true`を設定すると、設定済みロケールの翻訳ルールから除外されます。自動生成されたページは、`docs-/`配下に対応するコピーを用意する必要がありません。このフィールドはフレームワークが管理するキーでもあるため、デフォルトではフロントマタープレビューから非表示になります。 ```mdx --- title: Auto-generated Reference generated: true --- ``` [Dynamic content unavailable in text export] 通常`generated`を手動で設定することはありません。ジェネレーターが自動的に付与します。ロケールワークフローでは設定した追加ロケールに手書きページのミラーだけが必要なため、`generated: true`のページは翻訳対象から除外されます。 ### `pagination_next` - **型：** `string | null` - **必須：** いいえ - **デフォルト：** サイドバーの順序から自動的に決定 ドキュメントの下部に表示される「次へ」ページリンクをオーバーライドします。ドキュメントパス（例：`"guides/configuration"`）を設定して特定のページにリンクするか、`null`に設定して次のリンクを完全に非表示にします。 ```mdx --- title: Final Step pagination_next: null --- ``` ### `pagination_prev` - **型：** `string | null` - **必須：** いいえ - **デフォルト：** サイドバーの順序から自動的に決定 ドキュメントの下部に表示される「前へ」ページリンクをオーバーライドします。ドキュメントパス（例：`"getting-started/introduction"`）を設定して特定のページにリンクするか、`null`に設定して前のリンクを完全に非表示にします。 ```mdx --- title: Getting Started pagination_prev: null --- ```