Configuration

Config File

Without any configuration, the VuePress site is pretty minimal. To customize your site, let’s first create a .vuepress directory inside your docs directory. This is where all VuePress-specific files will be placed. Your project structure is probably like this:

├─ docs
│  ├─ .vuepress
│  │  └─ config.js
│  └─ README.md
├─ .gitignore
└─ package.json
1
2
3
4
5
6

The essential file for configuring a VuePress site is .vuepress/config.js, which should export a JavaScript object. If you are using TypeScript, you can use .vuepress/config.ts instead to get better types hint for VuePress Config.

module.exports = {
  // site config
  lang: 'en-US',
  title: 'Hello, VuePress!',
  description: 'This is my first VuePress site',

  // theme and its config
  theme: '@vuepress/theme-default',
  themeConfig: {
    logo: 'https://vuejs.org/images/logo.png',
  },
}
1
2
3
4
5
6
7
8
9
10
11
12
import { defineUserConfig } from 'vuepress'
import type { DefaultThemeOptions } from 'vuepress'

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

  // theme and its config
  theme: '@vuepress/theme-default',
  themeConfig: {
    logo: 'https://vuejs.org/images/logo.png',
  },
})
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

TIP

Check out the Config Reference for a full list of VuePress config.

Config Scopes

You may have noticed that there is a themeConfig option in VuePress config.

Options outside themeConfig are Site Config, while options inside themeConfig are Theme Config.

Site Config

Site config means that, no matter what theme you are using, these configurations are always valid.

As we know, every site should have its own lang, title, description, etc. Thus, VuePress has built-in support for those options.

Theme Config

Theme config will be processed by VuePress theme, so it depends on the theme you are using.

If you don't specify the theme option of VuePress config, the default theme will be used.

TIP

Check out the Default Theme > Config Reference for theme config of default theme.