Front Matter

任何包含 YAML front matter 的 Markdown 文件都将由 gray-matter 处理。front matter 必须是 markdown 文件中的第一部分，并且必须采用在三点划线之间书写的有效的 YAML。 这是一个基本的例子：

  1. ---
  2. title: Blogging Like a Hacker
  3. lang: en-US
  4. ---

在这些三条虚线之间，你可以设置预定义变量（参见下面），甚至可以创建自己的自定义变量。 然后，您可以使用 $frontmatter 在页面的其余部分、以及所有的自定义和主题组件访问这些变量。

提示

在 VuePress 中，Front matter 是 可选的。

其他格式的 Front Matter

除了 YAML 之外，VuePress 也支持 JSON 或者 TOML 格式的 front matter。

JSON front matter 需要以花括号开头和结尾：

  1. ---
  2. {
  3.   "title": "Blogging Like a Hacker",
  4.   "lang": "en-US"
  5. }
  6. ---

TOML front matter 需要显式地标注为 TOML：

  1. ---toml
  2. title = "Blogging Like a Hacker"
  3. lang = "en-US"
  4. ---

预定义变量

title

  • 类型: string
  • 默认值: h1_title || siteConfig.title当前页面的标题。

lang

  • 类型: string
  • 默认值: en-US当前页面的语言。

description

  • 类型: string
  • 默认值: siteConfig.description当前页面的描述。

layout

  • 类型: string
  • 默认值: Layout设置当前页面的布局组件。
  • 类型: string
  • 默认值: siteConfig.permalink参考: Permalinks.

metaTitle

  • 类型: string
  • 默认值: ${page.title} | ${siteConfig.title}重写默认的 meta title。

meta

  • 类型: array
  • 默认值: undefined指定额外的要注入的 meta 标签：
  1. ---
  2. meta:
  3.   - name: description
  4.     content: hello
  5.   - name: keywords
  6.     content: super duper SEO
  7. ---

默认主题的预定义变量

navbar

sidebar