Skip to content
当前页导航

Frontmatter

用法

VitePress 支持所有 Markdown 文件中的 YAML frontmatter,并使用 gray-matter 进行解析。 frontmatter 必须位于 Markdown 文件的顶部(在包括 <script> 标记的任何元素之前),并且必须采用三虚线之间设置的有效 YAML 的形式。例子:

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

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

您还可以定义自己的自定义 frontmatter 数据,以在页面上的动态 Vue 表达式中使用。

访问 Frontmatter 数据

Frontmatter 数据可以通过特殊的 $frontmatter 全局变量访问:

以下是如何在 Markdown 文件中使用它的示例:

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

# {{ $frontmatter.title }}

Guide content

您还可以使用 useData() 帮助程序在 <script setup> 中访问当前页面的 frontmatter 数据。

替代前置元数据格式

VitePress 还支持 JSON frontmatter 语法,以大括号开头和结尾:

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

本文档由全栈行动派(qzxdp.cn)翻译并整理