Skip to main content

文档结构

About 2 min布局布局页面

图标支持

你可以在页面的 frontmatter 中配置 icon 字段,填入对应图标的 FontClass 即可绑定图标到页面。

该图标会在导航栏,侧边栏,路径导航和标题中使用。

例子
---
icon: home
---

Info

图标的相关设置,详见 图标支持

路径导航

主题添加了开箱即用的路径导航支持。

你可以在主题选项和页面 Frontmatter 中通过 breadcrumb 设置一个布尔值来控制全局和特定页面的路径导航显示。

路径导航的图标也是可配置的,你可以在主题选项和页面 Frontmatter 中通过 breadcrumbIcon 设置一个布尔值来控制全局和特定页面的行为。

如果你不希望某个页面被添加到路径导航中(例如:首页),你可以在页面的 Frontmatter 中设置 breadcrumbExclude: true

文章信息展示

详见 文章信息 章节。

标题列表

在桌面模式下,文章的标题列表会自动显示在屏幕的右侧。(在移动视图下它们会放置在侧边栏里)

如果你不希望在桌面模式下显示右侧的标题列表,请在主题选项中设置 toc: false

你也可以在特定页面的 Frontmatter 中通过 toc 来指定它。

设置标题深度

你可以通过在主题选项和页面 Frontmatter 中设置 headerDepth 来自定义标题列表的深度。

上 / 下一篇链接

上一篇和下一篇文章的链接将会自动地根据当前页面的侧边栏的顺序来获取。你也可以通过主题选项或 frontmatter 来明确地重写或者禁用它:

---
prev: ./some-other-page
next: false
---

你也可以通过传递一个拥有 title, icon 和 link 的对象来完全自定义它。