Frontmatter 配置 ​

Frontmatter 支持基于页面的配置。在每个 Markdown 文件中，您可以使用 frontmatter 配置来覆盖站点级或主题级配置选项。此外，还有一些配置选项只能在 frontmatter 中定义。

用法示例：

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

您可以通过 Vue 表达式中的全局 $frontmatter 访问 frontmatter 数据：

{{ $frontmatter.title }}

title ​

• 类型: string

页面的标题。它与 config.title 相同，并且覆盖站点级配置。

---
title: VitePress
---

titleTemplate ​

• 类型: string | boolean

标题的后缀。它与 config.titleTemplate 相同，并且覆盖站点级配置。

---
title: VitePress
titleTemplate: Vite & Vue powered static site generator
---

description ​

• 类型: string

页面的描述。它与 config.description 相同，并且覆盖站点级配置。

---
description: VitePress
---

head ​

• 类型: HeadConfig[]

指定要为当前页面注入的额外头标签。将附加在站点级配置注入的头标签之后。

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

type HeadConfig =
  | [string, Record<string, string>]
  | [string, Record<string, string>, string]

仅默认主题 ​

以下 frontmatter 选项仅在使用默认主题时适用。

layout 仅默认主题 ​

• 类型: doc | home | page
• 默认值: doc

确定页面的布局。

• doc - VitePress会将默认的文档样式应用于Markdown内容。
• home - VitePress为"首页"提供了特殊的布局。您可以添加额外的选项，比如hero和features，以快速创建漂亮的首页。
• page - 与doc类似，但不对内容应用任何样式。在您想创建完全自定义页面时非常有用。

---
layout: doc
---

hero 仅默认主题 仅首页 ​

定义当layout设置为home时 home hero部分的内容。更多详细信息请参见默认主题：首页。

features 仅默认主题 仅首页 ​

定义当layout设置为home时要在功能部分中显示的项目。更多详细信息请参见默认主题：首页。

navbar default theme only ​

• 类型: boolean
• 默认值: true

是否显示导航栏。

---
navbar: false
---

sidebar default theme only ​

• 类型: boolean
• 默认值: true

是否显示侧边栏。

---
sidebar: false
---

aside 仅默认主题 ​

• 类型: boolean | 'left'
• 默认值: true

定义doc布局中旁注组件的位置。

将此值设置为false可防止渲染旁路容器。
将此值设置为true会将旁边渲染到右侧。
将此值设置为left会将一侧呈现在左侧。

---
aside: false
---

outline 仅默认主题 ​

• 类型: number | [number, number] | 'deep' | false
• 默认值: 2

为页面显示的大纲中标题的级别。它与 config.themeConfig.outline 相同，并且覆盖主题配置。

lastUpdated 仅默认主题 ​

• 类型: boolean
• 默认值: true

是否在当前页面的页脚显示上次更新时间文本。

---
lastUpdated: false
---

editLink 仅默认主题 ​

• 类型: boolean
• 默认值: true

是否在当前页面的页脚显示编辑链接。

---
editLink: false
---

footer 仅默认主题 ​

• 类型: boolean
• 默认值: true

是否显示页脚。

---
footer: false
---