布局 Frontmatter 配置

  • 配置
  • 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 可用)

文章信息展示项目。

pageview

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

是否显示浏览量。

提示

显示浏览量功能需要你拥有有效的 Waline 评论服务配置。

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

是否开启路径导航。

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

是否开启路径导航图标。

  • 类型: boolean

导航栏配置,填入 false 会禁用导航栏

  • 类型: "heading" | false

侧边栏配置选项。支持 "heading"false

headerDepth

  • 类型: number
  • 默认值: 2

标题渲染深度。

index

  • 类型: boolean
  • 默认值: true

Whether index current page in sidebar.

order

  • 类型: number

Page order in sidebar.

  • By filling in a positive number, the page will appear in the front, while the smaller number comes to the front.
  • By filling in a negative number, the page will appear in the end, while the greater number comes to the front. (e.g. -1 is after -2)

dir

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

dir.text

分组标题。

dir.icon

分组图标。

dir.collapsible

  • 类型: boolean
  • 默认值: true

分组是否可折叠。

  • 类型: boolean
  • 默认值: false

分组是否可点击

设置为 true 意味着将分组链接设置为 README.mdopen in new window 链接。

dir.index

  • 类型: boolean
  • 默认值: true

是否索引当前目录

dir.order

  • 类型: number

分组在侧边栏的顺序

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

comment

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

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

lastUpdated

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

是否显示最后更新时间。

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

是否显示编辑链接。

contributors

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

是否显示贡献者。

prev

  • 类型: AutoLinkOptions | string | false

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

上一篇文章链接。

next

  • 类型: AutoLinkOptions | string | false

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

下一篇文章链接。

  • 类型: boolean | string | HTMLString

设置页脚内容。

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

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

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

设置版权信息,更多详情请看 页面 → 页脚支持

backToTop

  • 类型: boolean
  • 默认值: true

设置是否显示返回顶部按钮

toc

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

设置在桌面模式下是否在右侧显示标题列表。

containerClass

  • 类型: string
  • 必填: 否

额外的页面容器 Class。

layout

  • 类型: string
  • 默认值: "Layout"

页面的自定义布局名称。

Loading...