页面布局

layout

类型：doc | home | page
默认值：doc

指定页面的布局

doc——它将默认文档样式应用于 markdown 内容。
home——“主页”的特殊布局。可以添加额外的选项，例如 hero 和 features，以快速创建漂亮的落地页。
page——表现类似于 doc，但它不对内容应用任何样式,被视为“空白页”。当想创建一个完全自定义的页面时很有用。

yaml

---
layout: doc
---

无布局

如果不想要任何布局，可以通过 frontmatter 传递 layout: false。如果想要一个完全可自定义的登录页面（默认情况下没有任何侧边栏、导航栏或页脚），此选项很有用。

自定义布局

yaml

---
layout: foo
---

例如，可以在 .vitepress/theme/index.ts中全局注册组件

yaml

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

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

类型：boolean
默认值：true

是否显示导航栏

yaml

---
navbar: false
---

aside

类型：boolean | 'left'
默认值：true

定义侧边栏组件在 doc 布局中的位置

将此值设置为 false 可禁用侧边栏容器。将此值设置为 true 会将侧边栏渲染到右侧。将此值设置为 left会将侧边栏渲染到左侧。

yaml

---
aside: false
---

pageClass

类型：string

将额外的类名称添加到特定页面

yaml

---
pageClass: custom-page-class
---

然后可以在 .vitepress/theme/custom.css 文件中自定义该特定页面的样式：

yaml

.custom-page-class {
  /* 特定页面的样式 */
}

页面布局 ​

layout ​

navbar ​

aside ​

pageClass ​

页面布局

layout

navbar

aside

pageClass