跳至内容

布局

您可以通过将 layout 选项设置为页面 前置信息 来选择页面布局。有 3 种布局选项,docpagehome。如果没有指定,则页面将被视为 doc 页面。

yaml
---
layout: doc
---

文档布局

选项 doc 是默认布局,它将整个 Markdown 内容样式化为“文档”外观。它通过将整个内容包装在 vp-doc css 类中,并对其中的元素应用样式来实现。

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

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

页面布局

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

页面布局将允许您根据自己的需要对所有内容进行样式设置,而不会受到 VitePress 主题对标记的影响。当您想创建自己的自定义页面时,这很有用。

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

主页布局

选项 home 将生成模板化的“主页”。在此布局中,您可以设置额外的选项,例如 herofeatures,以进一步自定义内容。有关更多详细信息,请访问 默认主题:主页

无布局

如果您不想要任何布局,可以通过前置信息传递 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)
  }
}