配置

配置文件

文档正在编撰中,敬请期待!

module.exports = {
  lang: 'zh-CN',
  title: '你好, VuePress !',
  description: '这是我的第一个 VuePress 站点',

  themeConfig: {
    logo: 'https://vuejs.org/images/logo.png',
  },
}
1
2
3
4
5
6
7
8
9
import { defineUserConfig } from 'vuepress'
import type { DefaultThemeOptions } from 'vuepress'

export default defineUserConfig<DefaultThemeOptions>({
  lang: 'en-US',
  title: 'Hello VuePress',
  description: 'Just playing around',

  themeConfig: {
    logo: 'https://vuejs.org/images/logo.png',
  },
})
1
2
3
4
5
6
7
8
9
10
11
12

TIP

我们接下来会把这个配置对象称为 VuePress 配置.

配置作用域

你可能已经注意到了,在 VuePress 配置中有一项 themeConfig 配置项。

themeConfig 外部的配置项属于 站点配置 ,而在 themeConfig 内部的配置项则属于 主题配置

站点配置

站点配置的意思是,无论你使用什么主题,这些配置项都可以生效。

我们知道,每一个站点都应该有它的 lang, titledescription 等属性,因此 VuePress 内置支持了这些属性的配置。

TIP

前往 配置参考 查看所有站点配置。

主题配置

主题配置将会被 VuePress 主题来处理,所以它取决于你使用的主题是什么。

如果你没有设置 VuePress 配置的 theme 配置项,则代表使用的是默认主题。

TIP

前往 默认主题 > 配置参考 查看默认主题的配置。

Last Updated: 2021/10/20 上午12:51:09
Contributors: Rhyheart