フロントマター (Frontmatter)
フロントマターは、ページ冒頭に配置する YAML 形式のメタデータブロックです。ページのメタ情報の定義、表示順序の制御、およびナビゲーションの挙動設定に使用します。
---
title: ガイド
weight: 10
hidden: false
isRoot: true
exclude: false
date: 2025-01-01
starryNight: true
---
フィールド仕様
title: ページタイトル(ナビゲーションメニューおよび HTML の<title>タグに使用)。excerpt/description: メタタグ用の短い要約(どちらのフィールド名も使用可能です)。weight: ナビゲーションの表示順序(数値が小さいほど上位に表示されます)。hidden: ナビゲーションメニューから非表示にします(/404およびisRoot設定ページはデフォルトで非表示となります)。isRoot:index.mdxに設定し、そのディレクトリをナビゲーションの起点(ルート)として定義します。exclude: 開発およびビルドプロセスからページを完全に除外します。ディレクトリのインデックスに設定した場合は配下すべてが除外されます。date:weightが同一の場合のセカンダリソートキーとして使用されます。lang: 言語スイッチャーに表示されるラベル。各言語ディレクトリのindex.mdxでのみ有効です。langCode: HTML のlang属性に適用される言語コード。各言語ディレクトリのindex.mdxでのみ有効です。starryNight: ページ単位での構文ハイライトの制御(true/false/ 詳細設定オブジェクト)。
注意事項
isRootプロパティはindex.mdxファイルにのみ適用可能です。isRootが設定されたページは、デフォルトでナビゲーションから隠蔽されます。メニューに表示させたい場合は、明示的にhidden: falseを指定してください。_または.で始まるファイルおよびディレクトリは、常にナビゲーションから自動除外されます。- フロントマターで設定された
starryNightの値は、グローバル設定や CLI 引数よりも優先的に適用されます。 - フロントマターの解析には gray-matter が使用されています。
具体的な活用例
多言語インデックスの設定例
各言語ディレクトリのトップ(index.mdx)にのみ設定を行います。
---
title: 日本語
lang: 日本語
langCode: ja
isRoot: true
hidden: true
---