vitepress/docs/ja/guide/frontmatter.md

フロントマター

使い方

VitePress はすべての Markdown ファイルで YAML フロントマターをサポートしており、gray-matter で解析します。フロントマターは Markdown ファイルの先頭（<script> タグを含むあらゆる要素より前）に配置し、三本のハイフンで囲まれた 有効な YAML 形式で記述します。例:

 ---
 title: Docs with VitePress
 editLink: true
 ---

サイトやデフォルトテーマの多くの設定オプションには、フロントマター上で対応するオプションがあります。フロントマターを使うことで、そのページに限って 特定の振る舞いを上書きできます。詳細は Frontmatter Config Reference を参照してください。

また、独自のカスタムフロントマターデータを定義し、ページ上の動的な Vue 式で利用することもできます。

フロントマターデータへのアクセス

フロントマターデータは特別なグローバル変数 $frontmatter で参照できます。

Markdown ファイル内での使用例:

 ---
 title: Docs with VitePress
 editLink: true
 ---

 # {{ $frontmatter.title }}

 Guide content

useData() ヘルパーを使えば、<script setup> 内からも現在のページのフロントマターデータにアクセスできます。

代替フロントマター形式

VitePress は JSON フロントマター構文もサポートしています。中括弧で開始・終了する形式です。

 ---
 {
   "title": "Blogging Like a Hacker",
   "editLink": true
 }
 ---