前置信息

用法

VitePress 支持所有 Markdown 文件中的 YAML 前置信息，使用 gray-matter 解析它们。前置信息必须位于 Markdown 文件的顶部（在任何元素之前，包括 <script> 标签），并且必须采用在三条破折号之间设置的有效 YAML 格式。示例

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

许多站点或默认主题配置选项在前面信息中具有相应的选项。您可以使用前面信息仅覆盖当前页面的特定行为。有关详细信息，请参阅 前置信息配置参考。

您还可以定义自己的自定义前面信息数据，以便在页面上的动态 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
}
---