# Frontmatter

任何包含 YAML frontmatter 块都将由gray-matter处理. frontmatter 必须位于 Markdown 文件的顶部, 并且必须采用在三条虚线之间设置的有效 YAML 的形式. 示例:

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

在三条虚线之间, 您可以设置预定义变量, 甚至可以创建您自己的自定义变量. 这些变量可以通过$FrontMatter变量使用.

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

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

# {{ $frontmatter.title }}

Guide content

# 备选 frontmatter 格式

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

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

# 预定义变量

# title

• Type: string
• Default: h1_title || siteData.title

当前页面的标题.

# head

• Type: array
• Default: undefined

指定需要注入的额外头标签:

---
head:
  - - meta
    - name: description
      content: hello
  - - meta
    - name: keywords
      content: super duper SEO
---

# navbar

• Type: boolean
• Default: undefined

您可以使用navbar: false禁用特定页面上的导航栏

# sidebar

• Type: boolean|'auto'
• Default: undefined

您可以使用sidebar: auto决定在特定页面上显示侧边栏, 也可以使用sidebar: false将其禁用

# editLink

• Type: boolean
• Default: undefined

定义此页面是否应包含编辑链接.