布局 Frontmatter 配置

大约 3 分钟

你可以在页面的 frontmatter 配置以下选项控制页面布局。

pageInfo

类型: PageInfo[] | false
默认值: 主题选项中的值
详情:
- 功能 → 页面信息

自定义当前页面的页面信息。

PageInfo 可选的值和对应内容如下:

条目	对应内容	页面 frontmatter 值
`"Author"`	作者	`author`
`"Date"`	写作日期	`date`
`"Original"`	是否原创	`isOriginal`
`"Category"`	分类	`category`
`"Tag"`	标签	`tag`
`"ReadingTime"`	预计阅读时间	N/A(自动生成)
`"Word"`	字数	N/A(自动生成)
`"PageView"`	访问量	`pageview` (仅 Waline 可用)

类型: boolean
默认值: 主题选项中的值
详情:
- 布局 → 页面

是否开启路径导航。

breadcrumbIcon

类型: boolean
默认值: 主题选项中的值
详情:
- 布局 → 页面

是否在路径导航中显示图标。

breadcrumbExclude

类型: boolean
默认值: false
详情:
- 布局 → 页面

当前页面是否被路径导航排除。

类型: boolean
详情:
- 布局 → 导航栏

填入 false 会禁用导航栏

类型: boolean
详情:
- 布局 → 侧边栏

填入 false 会禁用侧边栏

headerDepth

类型: number
默认值: 2
详情:
- 布局 → 页面

标题渲染深度。

index

类型: boolean
默认值: true

是否在侧边栏或目录中索引当前页面。

order

类型: number

指定当前页面在侧边栏或目录中的排序

当填写正数的时候，页面将排在靠前的位置，数字越小出现的位置越前。
当填写负数的时候，页面将排在靠后的位置，数字越大出现的位置越前（比如 -1 在 -2 之后）。

dir

用于结构侧边栏的分组信息。

dir.text

类型: string
默认值: README.md 的标题

分组标题。

dir.icon

类型: string
默认值: README.md 的图标

分组图标。

dir.collapsible

类型: boolean
默认值: true

分组是否可折叠。

dir.link

类型: boolean
默认值: false

分组是否可点击

注

设置为 true 意味着将分组链接设置为 README.md 链接。

dir.index

类型: boolean
默认值: true

是否索引当前目录

dir.order

类型: number

分组在侧边栏的顺序

填写正数，页面会出现在最前，较小的数字会出现在前面。
填写负数，页面会出现在最后，较大的数字会出现在前面。 (如 -1 在 -2 之后)

comment

类型: boolean
默认值: 主题选项中的值

当前页面是否开启评论功能。

lastUpdated

类型: boolean
默认值: 主题选项中的值

是否显示最后更新时间。

editLink

类型: boolean
默认值: 主题选项中的值

是否显示编辑链接。

contributors

类型: boolean
默认值: 主题选项中的值

是否显示贡献者。

类型: AutoLinkConfig | string | false

interface AutoLinkConfig {
  text: string;
  icon: string;
  link: string;
}

上一篇文章链接。

类型: AutoLinkConfig | string | false

interface AutoLinkConfig {
  text: string;
  icon: string;
  link: string;
}

下一篇文章链接。

类型: boolean | string | HTMLString

页脚内容。

设置为 false 以禁用页脚
设置为 "" 以移除默认的页脚内容，
设置为 true 以使用默认页脚。

更多详情请看页面 → 页脚支持

copyright

类型: string | false
默认值: 主题选项中的值

版权信息。

更多详情请看页面 → 页脚支持

backToTop

类型: boolean
默认值: true

是否显示返回顶部按钮

containerClass

类型: string
必填: 否

额外的页面容器 Class。

layout

类型: string
默认值: "Layout"

页面的自定义布局名称。