文档仅用于主题展示，最新Vuepress使用文档请前往官方站点
Frontmatter
所有页面
本章节中的 Frontmatter 会在所有类型的页面中生效。
navbar
类型：
boolean详情：
是否在当前页面展示导航栏。
如果你在主题配置中禁用了导航栏，那么该 Frontmatter 将不会生效。
参考：
pageClass
类型：
string详情：
为当前页面添加额外的类名。
示例：
---
pageClass: custom-page-class
---
2
3
然后你可以在 .vuepress/styles/index.scss 文件中为这个页面添加自定义样式：
.theme-container.custom-page-class {
/* 页面样式 */
}
2
3
首页
本章节中的 Frontmatter 只会在首页中生效。
home
类型：
boolean详情：
设定该页面是首页还是普通页面。
如果你不设置该 Frontmatter 或将其设为
false，则该页面会是一个 普通页面示例：
--- home: true ---1
2
3
heroImage
类型：
string详情：
首页图片的 URL 。
示例：
--- # Public 文件路径 heroImage: /images/hero.png # URL heroImage: https://vuejs.org/images/logo.png ---1
2
3
4
5
6参考：
heroAlt
类型：
string详情：
首页图片的
alt属性。如果不设置，则默认使用 heroText 。
heroText
类型：
string | null详情：
首页的大标题。
如果不设置，则默认使用站点 title 。
设置为
null来禁用首页大标题。
tagline
类型：
string | null详情：
首页的标语。
如果不设置，则默认使用站点 description 。
设置为
null来禁用首页标语。
actions
- 类型：
Array<{
text: string
link: string
type?: 'primary' | 'secondary'
}>
2
3
4
5
详情：
配置首页按钮。
示例：
---
actions:
- text: 快速上手
link: /zh/guide/getting-started.html
type: primary
- text: 项目简介
link: /guide/
type: secondary
---
2
3
4
5
6
7
8
9
features
- 类型：
Array<{
title: string
details: string
}>
2
3
4
详情：
配置首页特性列表。
示例：
---
features:
- title: 简洁至上
details: 以 Markdown 为中心的项目结构，以最少的配置帮助你专注于写作。
- title: Vue 驱动
details: 享受 Vue 的开发体验，可以在 Markdown 中使用 Vue 组件，又可以使用 Vue 来开发自定义主题。
- title: 高性能
details: VuePress 会为每个页面预渲染生成静态的 HTML，同时，每个页面被加载的时候，将作为 SPA 运行。
---
2
3
4
5
6
7
8
9
footer
类型：
string详情：
首页的页脚。
footerHtml
类型：
boolean详情：
是否允许页脚中使用 HTML 。
如果设置为
true，那么 footer 会被作为 HTML 代码处理。
普通页面
本章节中的 Frontmatter 只会在普通页面中生效。
editLink
类型：
boolean详情：
是否在本页面中启用 编辑此页 链接。
参考：
lastUpdated
类型：
boolean详情：
是否在本页面中启用 最近更新时间戳 。
参考：
contributors
类型：
boolean详情：
是否在本页面中启用 贡献者列表 。
参考：
sidebar
类型：
false | 'auto' | SidebarConfigArray | SidebarConfigObject详情：
配置本页面的侧边栏。
参考：
sidebarDepth
类型：
number详情：
配置本页面的侧边栏深度。
参考：
prev
类型：
NavLink | string详情：
上一个页面的链接。
如果你不设置该 Frontmatter ，该链接会自动根据侧边栏配置进行推断。
为了手动配置上一页面的链接，你可以将其设置为一个
NavLink对象或者一个字符串：NavLink对象应该有一个text字段和一个link字段。- 字符串应为目标页面文件的路径。它将会被转换为
NavLink对象，将页面标题作为text，将页面路由路径作为link。
示例：
---
# NavLink
prev:
text: Get Started
link: /guide/getting-started.html
# NavLink - 外部 URL
prev:
text: GitHub
link: https://github.com
# 字符串 - 页面文件路径
prev: /guide/getting-started.md
# 字符串 - 页面文件相对路径
prev: ../../guide/getting-started.md
---
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
next
类型：
NavLink | string详情：
下一个页面的链接。
如果你不设置该 Frontmatter ，该链接会自动根据侧边栏配置进行推断。
类型和 prev Frontmatter 相同。