フロントマター
zudo-docドキュメントで利用可能なすべてのフロントマターフィールドの完全なリファレンス。
zudo-docのすべてのMDXファイルは---で区切られたYAMLフロントマターブロックで始まります。このページでは利用可能なすべてのフィールドを説明します。
完全な例
---
title: My Documentation Page
description: A comprehensive guide to something important.
sidebar_position: 3
sidebar_label: My Page
tags: [tutorial, setup]
---
Your content here.最小限の例
必須なのはtitleのみです：
---
title: Quick Start
---フィールド一覧
| フィールド | 型 | 必須 | デフォルト | 説明 |
|---|---|---|---|---|
title | string | はい | — | ページタイトル。見出し、サイドバー、ブラウザタブに表示 |
description | string | いいえ | — | タイトル下に表示されるサブタイトル |
sidebar_position | number | いいえ | 999 | サイドバーカテゴリ内のソート順 |
sidebar_label | string | いいえ | titleの値 | サイドバーに表示されるラベルのオーバーライド |
category | string | いいえ | ディレクトリ名 | 将来の使用のために予約 |
search_exclude | boolean | いいえ | false | ページを検索インデックスから除外 |
tags | string[] | いいえ | — | 横断的なナビゲーション用タグ |
draft | boolean | いいえ | false | 本番ビルドから除外（開発時は表示） |
unlisted | boolean | いいえ | false | ビルドされるがサイドバー、検索、検索エンジンから非表示 |
hide_sidebar | boolean | いいえ | false | 左サイドバーを非表示にし、コンテンツを狭いコンテナに中央揃え |
hide_toc | boolean | いいえ | false | 右側の目次を非表示 |
standalone | boolean | いいえ | false | サイドバーナビゲーションから非表示だがインデックスされる（unlistedとは異なる） |
slug | string | いいえ | ファイルパスから導出 | カスタムURLスラグのオーバーライド |
pagination_next | string | null | いいえ | 自動 | 次のページリンクをオーバーライド、nullで非表示 |
pagination_prev | string | null | いいえ | 自動 | 前のページリンクをオーバーライド、nullで非表示 |
フィールド詳細
title
- 型：
string - 必須： はい
ページタイトル。ページのh1見出し、サイドバーナビゲーション、ブラウザタブ、検索結果に表示されます。
---
title: Getting Started with zudo-doc
---description
- 型：
string - 必須： いいえ
ページの短い説明またはサブタイトル。レンダリングされたページでタイトルの下に表示されます。SEOメタタグにも使用されます。
---
title: Installation
description: How to install and set up zudo-doc for your project.
---sidebar_position
- 型：
number - 必須： いいえ
- デフォルト：
999（末尾に表示）
サイドバーカテゴリ内のページのソート順を制御します。小さい数値ほど先に表示されます。
---
title: Introduction
sidebar_position: 1
---💡 Tip
カテゴリインデックスページ（index.mdx）では、sidebar_positionはカテゴリ全体がサイドバー内の他のカテゴリに対してどこに表示されるかも制御します。
sidebar_label
- 型：
string - 必須： いいえ
- デフォルト：
titleの値
サイドバーナビゲーションに表示されるラベルをオーバーライドします。完全なページタイトルよりも短い、または異なるラベルを表示したい場合に使用します。
---
title: Configuring Color Schemes and Themes
sidebar_label: Color Schemes
---category
- 型：
string - 必須： いいえ
- デフォルト： ディレクトリ構造から導出（最初のディレクトリセグメント）
将来の使用のために予約されています。このフィールドはコンテンツスキーマで定義されていますが、現在はサイドバーやルーティングロジックでは使用されていません。カテゴリは常にディレクトリ構造から導出されます。
📝 Note
ページをカテゴリに整理するには、src/content/docs/の下にディレクトリを作成してその中に配置します。ディレクトリ名がカテゴリ名になります。
search_exclude
- 型：
boolean - 必須： いいえ
- デフォルト：
false
trueに設定すると、ページを検索インデックスから除外します。検索結果に表示すべきでない内部ページ、変更履歴、インポートされたコンテンツに便利です。
---
title: Internal Changelog
search_exclude: true
---tags
- 型：
string[] - 必須： いいえ
横断的なナビゲーション用のタグをページに割り当てます。タグはページにクリック可能なバッジとして表示され、タグインデックスページが/docs/tags/と/docs/tags/[tag]に自動生成されます。
---
title: Deploying to Netlify
tags: [deployment, netlify, hosting]
---💡 Tip
タグは、異なるサイドバーカテゴリにまたがる関連ページをグループ化するのに便利です。
draft
- 型：
boolean - 必須： いいえ
- デフォルト：
false
trueに設定すると、ページは本番ビルドから完全に除外されます。下書きページはプレビュー目的で開発時（pnpm dev）には引き続き表示されます。
---
title: Upcoming Feature
draft: true
---unlisted
- 型：
boolean - 必須： いいえ
- デフォルト：
false
trueに設定すると、ページはビルドされてURL経由でアクセス可能ですが、サイドバーナビゲーション、検索インデックス、検索エンジン（noindexメタタグ経由）からは非表示になります。
---
title: Internal Notes
unlisted: true
---hide_sidebar
- 型：
boolean - 必須： いいえ
- デフォルト：
false
trueに設定すると、デスクトップで左側のサイドバーが非表示になり、コンテンツが狭いコンテナに中央揃えで表示されます。モバイルのハンバーガーメニューからは引き続きナビゲーションにアクセスできます。ランディングページ、スタンドアロンの記事、フルワイドの読書体験が望ましいページに便利です。
---
title: About This Project
hide_sidebar: true
---ℹ️ Info
ライブデモでこのレイアウトオプションを実際に確認できます。
hide_toc
- 型：
boolean - 必須： いいえ
- デフォルト：
false
trueに設定すると、右側の目次（セクションナビゲーション）とモバイルの目次の両方が非表示になります。メインコンテンツエリアが利用可能な幅いっぱいに広がります。
---
title: Changelog
hide_toc: true
---ℹ️ Info
ライブデモでこのレイアウトオプションを実際に確認できます。
💡 Tip
hide_sidebarとhide_tocを組み合わせて、ナビゲーションパネルのないクリーンでセンタリングされた読みやすいレイアウトを作成できます：
---
title: About
hide_sidebar: true
hide_toc: true
---両方のオプションを組み合わせたライブデモもご覧ください。
standalone
- 型：
boolean - 必須： いいえ
- デフォルト：
false
trueに設定すると、ページはサイドバーナビゲーションとサイトインデックスから非表示になりますが、URL経由でアクセス可能で検索エンジンにインデックスされます。unlistedとは異なり、standaloneページにはnoindexメタタグが付きません。
---
title: Terms of Service
standalone: true
---📝 Note
公開アクセス可能であるべきだがドキュメントナビゲーションには含めたくないページ（利用規約、特別なランディングページなど）にはstandaloneを使用します。検索エンジンのインデックスも防ぎたい場合はunlistedを使用します。
slug
- 型：
string - 必須： いいえ
- デフォルト： ファイルパスから導出
ページのURLスラグをオーバーライドします。ファイルパスから生成されるURLとは異なるURLにしたい場合に使用します。
---
title: Getting Started with zudo-doc
slug: quickstart
---このページはファイルの場所から導出されるデフォルトパスの代わりに/docs/quickstartでアクセスできるようになります。
pagination_next
- 型：
string | null - 必須： いいえ
- デフォルト： サイドバーの順序から自動的に決定
ドキュメントの下部に表示される「次へ」ページリンクをオーバーライドします。ドキュメントパス（例："guides/configuration"）を設定して特定のページにリンクするか、nullに設定して次のリンクを完全に非表示にします。
---
title: Final Step
pagination_next: null
---pagination_prev
- 型：
string | null - 必須： いいえ
- デフォルト： サイドバーの順序から自動的に決定
ドキュメントの下部に表示される「前へ」ページリンクをオーバーライドします。ドキュメントパス（例："getting-started/introduction"）を設定して特定のページにリンクするか、nullに設定して前のリンクを完全に非表示にします。
---
title: Getting Started
pagination_prev: null
---