Frontmatter

所有页面

本章节中的 Frontmatter 会在所有类型的页面中生效。

externalLinkIcon

navbar

  • 类型： boolean

  • 详情：

    是否在当前页面展示导航栏。

    如果你在主题配置中禁用了导航栏，那么该 Frontmatter 将不会生效。

  • 参考：

pageClass

  • 类型： string

  • 详情：

    为当前页面添加额外的类名。

  • 示例：

  1. ---
  2. pageClass: custom-page-class
  3. ---

然后你可以在 .vuepress/styles/index.scss 文件中为这个页面添加自定义样式：

  1. .theme-container.custom-page-class {
  2.   /* 页面样式 */
  3. }

首页

本章节中的 Frontmatter 只会在首页中生效。

home

  • 类型： boolean

  • 详情：

    设定该页面是首页还是普通页面。

    如果你不设置该 Frontmatter 或将其设为 false ，则该页面会是一个 普通页面

  • 示例：

    1. ---
    2. home: true
    3. ---

heroImage

  • 类型： string

  • 详情：

    首页图片的 URL 。

  • 示例：

    1. ---
    2. # Public 文件路径
    3. heroImage: /images/hero.png
    4. # URL
    5. heroImage: https://vuejs.org/images/logo.png
    6. ---

  • 参考：

heroImageDark

heroAlt

  • 类型： string

  • 详情：

    首页图片的 alt 属性。

    如果不设置，则默认使用 heroText 。

heroText

  • 类型： string | null

  • 详情：

    首页的大标题。

    如果不设置，则默认使用站点 title 。

    设置为 null 来禁用首页大标题。

tagline

  • 类型： string | null

  • 详情：

    首页的标语。

    如果不设置，则默认使用站点 description 。

    设置为 null 来禁用首页标语。

actions

  • 类型：
  1. Array<{
  2.   text: string
  3.   link: string
  4.   type?: 'primary' | 'secondary'
  5. }>

  • 详情：

    配置首页按钮。

  • 示例：

  1. ---
  2. actions:
  3.   - text: 快速上手
  4.     link: /zh/guide/getting-started.html
  5.     type: primary
  6.   - text: 项目简介
  7.     link: /guide/
  8.     type: secondary
  9. ---

features

  • 类型：
  1. Array<{
  2.   title: string
  3.   details: string
  4. }>

  • 详情：

    配置首页特性列表。

  • 示例：

  1. ---
  2. features:
  3.   - title: 简洁至上
  4.     details: 以 Markdown 为中心的项目结构，以最少的配置帮助你专注于写作。
  5.   - title: Vue 驱动
  6.     details: 享受 Vue 的开发体验，可以在 Markdown 中使用 Vue 组件，又可以使用 Vue 来开发自定义主题。
  7.   - title: 高性能
  8.     details: VuePress 会为每个页面预渲染生成静态的 HTML，同时，每个页面被加载的时候，将作为 SPA 运行。
  9. ---

footer

  • 类型： string

  • 详情：

    首页的页脚。

footerHtml

  • 类型： boolean

  • 详情：

    是否允许页脚中使用 HTML 。

    如果设置为 true ，那么 footer 会被作为 HTML 代码处理。

普通页面

本章节中的 Frontmatter 只会在普通页面中生效。

editLink

editLinkPattern

lastUpdated

contributors

sidebar

sidebarDepth

prev

  • 类型： NavLink | string

  • 详情：

    上一个页面的链接。

    如果你不设置该 Frontmatter ，该链接会自动根据侧边栏配置进行推断。

    为了手动配置上一页面的链接，你可以将其设置为一个 NavLink 对象或者一个字符串：

    • NavLink 对象应该有一个 text 字段和一个 link 字段。
    • 字符串应为目标页面文件的路径。它将会被转换为 NavLink 对象，将页面标题作为 text ，将页面路由路径作为 link 。

  • 示例：

  1. ---
  2. # NavLink
  3. prev:
  4.   text: Get Started
  5.   link: /guide/getting-started.html
  7. # NavLink - 外部 URL
  8. prev:
  9.   text: GitHub
  10.   link: https://github.com
  12. # 字符串 - 页面文件路径
  13. prev: /guide/getting-started.md
  15. # 字符串 - 页面文件相对路径
  16. prev: ../../guide/getting-started.md
  17. ---

next

  • 类型： NavLink | string

  • 详情：

    下一个页面的链接。

    如果你不设置该 Frontmatter ，该链接会自动根据侧边栏配置进行推断。

    类型和 prev Frontmatter 相同。