元数据(frontmatter)是位于 Markdown 文件顶部、由 --- 包裹的一段声明,用于描述这篇文章本身的属性,而不是文章正文的一部分。
---
title: 我的第一篇文章
---
# 正文从这里开始
这里是文章的实际内容。
--- 之间的内容按 字段名: 值的形式书写,一行一个字段。元数据结束(第二个 ---)之后的内容才是文章正文,会被作为 Markdown 解析渲染;元数据本身不会出现在最终渲染出的正文里。
元数据并没有固定必填的字段列表,它本质上是一组自由的键值对。最常用、也几乎总会填写的是 title,用于表示这篇文章的标题,进而可能被模板用于页面的标题、页头等位置。除此之外,可以按模板需要声明任意自定义字段(如 description、order、draft 等),这些字段是否被使用、如何被使用,取决于站点所用的模板与处理管线是否读取了它们。
在 Book 模式下,一篇文章的元数据字段会在构建过程中被自动提取出来,成为该页面可用的模板变量——写在元数据里的 title: 我的第一篇文章,可以直接在模板中以变量的形式引用。这一步是 Book 模式内置处理管线自动完成的,不需要额外配置。
这只是 模板变量从何而来 这个更大话题的其中一个来源;模板变量的完整语法、渲染上下文的组成方式,请参见 模板引擎 相关说明。如果使用 Site 模式并且希望达到类似 元数据自动变为模板变量 的效果,这一步需要自己在处理管线中显式完成,具体做法参见 组合 Steps 相关说明。