Skip to content
当前页导航

布局

您可以通过为页面 frontmatter 设置 layout 选项来选择页面布局。有 3 个布局选项:docpagehome。如果未指定任何内容,则该页面将被视为doc页面。

yaml
---
layout: doc
---

文档布局

选项doc是默认布局,它将整个 Markdown 内容设置为"文档"外观。它的工作原理是将整个内容包装在 vp-doc css 类中,并将样式应用于其下面的元素。

几乎所有通用元素(例如ph2)都有特殊的样式。因此,请记住,如果您在 Markdown 内容中添加任何自定义 HTML,这些内容也会受到这些样式的影响。

它还提供下面列出的文档特定功能。这些功能仅在此布局中启用。

  • 编辑连接
  • 上一页、下一页连接
  • 大纲
  • Carbon Ads

页面布局

选项page被视为"空白页"。 Markdown 仍将被解析,并且所有 Markdown 扩展 的工作方式与 doc 布局相同,但它不会获得任何默认样式。

页面布局可让您自行设计所有内容,而不会影响标记的 VitePress 主题。当您想要创建自己的自定义页面时,这非常有用。

请注意,即使在这种布局中,如果页面具有匹配的侧边栏配置,侧边栏仍然会显示。

首页布局

选项 home 将生成模板化的"首页"。在此布局中,您可以设置额外的选项,例如herofeatures以进一步自定义内容。请访问默认主题:首页了解更多详情。

无布局

如果你不需要任何布局,你可以通过 frontmatter 传递layout: false。如果您想要完全可自定义的登录页面(默认情况下没有任何侧边栏、导航栏或页脚),此选项会很有帮助。

自定义布局

您还可以使用自定义布局:

md
---
layout: foo
---

这将在上下文中查找名为foo的组件。例如,您可以在.vitepress/theme/index.ts中全局注册您的组件:

ts
import DefaultTheme from 'vitepress/theme'
import Foo from './Foo.vue'

export default {
  extends: DefaultTheme,
  enhanceApp({ app }) {
    app.component('foo', Foo)
  }
}

本文档由全栈行动派(qzxdp.cn)翻译并整理