应用级别配置: 基础

base

  • Type: string
  • Default: /

站点将部署在这个base URL。如果你计划将站点部署到子路径(例如GitHub页面),则需要设置这个选项。比如,你计划将站点部署到https://foo.github.io/bar/,那么你需要设置base'/bar/'。注意,base需要以/开始并以/结尾。

因为base会自动的被插入到到其他配置中所有以/开始的链接之前,所以你只需要指定一次。

module.exports = {
  base: '/base/'
}

lang

  • Type: string
  • Default: en-US

站点的lang属性。这个属性将作为<html lang="en-US">标记渲染到页面HTML中。

注意,lang属性只会通过vitepress build构建站点时添加, 通过 vitepress dev渲染时不会出现。

module.exports = {
  lang: 'en-US'
}

title

  • Type: string
  • Default: VitePress

站点的标题。 这是所有页面标题的前缀,并显示在导航栏中。

module.exports = {
  title: 'VitePress'
}

description

  • Type: string
  • Default: A VitePress site

站点的描述。 这将作为<meta>标记渲染在页面HTML中。

module.exports = {
  description: 'A VitePress site'
}