vitepress/docs/en/guide/frontmatter.md

description
Learn how to use YAML frontmatter in VitePress Markdown files to control page-level metadata and behavior.

Frontmatter

Usage

VitePress supports YAML frontmatter in all Markdown files, parsing them with gray-matter. The frontmatter must be at the top of the Markdown file (before any elements including <script> tags), and must take the form of valid YAML set between triple-dashed lines. Example:

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

Many site or default theme config options have corresponding options in frontmatter. You can use frontmatter to override specific behavior for the current page only. For details, see Frontmatter Config Reference.

You can also define custom frontmatter data of your own, to be used in dynamic Vue expressions on the page.

Accessing Frontmatter Data

Frontmatter data can be accessed via the special $frontmatter global variable:

Here's an example of how you could use it in your Markdown file:

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

# {{ $frontmatter.title }}

Guide content

Property accesses like {{ $frontmatter.title }} are resolved while the Markdown is rendered, so the value also ends up in the local search index, in content loader output, in heading anchors - the heading above gets id="docs-with-vitepress" - and in link targets written without spaces around the expression, like [text]({{$frontmatter.link}}). Other expressions are evaluated by Vue at runtime as usual, and wrapping an expression in v-pre shows it literally.

You can also access current page's frontmatter data in <script setup> with the useData() helper.

Alternative Frontmatter Formats

VitePress also supports JSON frontmatter syntax, starting and ending in curly braces:

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