# Config Reference of VuePress config, which can be set via config file. The conventional config files are (in order of precedence): - In current working directory `cwd`: - `vuepress.config.ts` - `vuepress.config.js` - In source directory `sourceDir`: - `.vuepress/config.ts` - `.vuepress/config.js` You can also specify the config file via `--config` option of [CLI](./cli.md). ## Site Config ### base - Type: `string` - Default: `/` - Details: The base URL the site will be deployed at. You will need to set this if you plan to deploy your site under a sub path. It should always start and end with a slash. For example, if you plan to deploy your site to GitHub pages at `https://foo.github.io/bar/`, then you should set `base` to `"/bar/"`. The `base` is automatically prepended to all the URLs that start with `/` in other options, so you only need to specify it once. - Also see: - [Guide > Assets > Base Helper](../guide/assets.md#base-helper) - [Guide > Deployment](../guide/deployment.md) ### lang - Type: `string` - Default: `en-US` - Details: Language for the site. This will be the `lang` attribute of the `` tag in the rendered HTML. This can be specified in different locales. - Also see: - [Config > locales](#locales) - [Frontmatter > lang](./frontmatter.md#lang) ### title - Type: `string` - Default: `''` - Details: Title for the site. This will be the suffix for all page titles, and displayed in the navbar in the default theme. This can be specified in different locales. - Also see: - [Config > locales](#locales) ### description - Type: `string` - Default: `''` - Details: Description for the site. This will be the `content` attribute of `` tag in the rendered HTML, which will be overrode by the `description` field of page frontmatter. This can be specified in different locales. - Also see: - [Config > locales](#locales) - [Frontmatter > description](./frontmatter.md#description) ### head - Type: `HeadConfig[]` - Default: `[]` - Details: Extra tags to inject into the `` tag in the rendered HTML. You can specify each tag in the form of `[tagName, { attrName: attrValue }, innerHTML?]`. This can be specified in different locales. - Example: To add a custom favicon: ```js module.exports = { head: [ ['link', { rel: 'icon', href: '/logo.png' }] ] } ``` Rendered as： ```html ``` - Also see: - [Config > locales](#locales) - [Frontmatter > head](./frontmatter.md#head) ### locales - Type: `{ [path: string]: Partial }` - Default: `{}` - Details: Specify locales for i18n support. Acceptable fields: - [lang](#lang) - [title](#title) - [description](#description) - [head](#head) - Also see: - [Guide > I18n](../guide/i18n.md) ## Theme Config ### theme - Type: `string` - Default: `'@vuepress/default'` - Details: Name or absolute path of theme your want to use. This option accepts theme name, theme name shorthand, or absolute path to theme. - Example: ```js module.exports = { theme: 'vuepress-theme-foo', theme: 'bar', theme: '/path/to/local/theme', } ``` - Also see: - [Guide > Theme](../guide/theme.md) ### themeConfig - Type: `ThemeConfig` - Default: `{}` - Details: Provide config options to the used theme. The options will vary depending on the theme you are using. - Also see: - [Default Theme > Config](./default-theme/config.md) ## Bundler Config ### bundler - Type: `string` - Default: `'@vuepress/webpack'` - Details: Name of bundler your want to use. Bundler name shorthand is acceptable. - Also see: - [Guide > Bundler](../guide/bundler.md) ### bundlerConfig - Type: `BundlerConfig` - Default: `{}` - Details: Provide config options to the used bundler. The options will vary depending on the bundler you are using. ## Directory Config ### dest - Type: `string` - Default: `` `${sourceDir}/.vuepress/dist` `` - Details: Specify the output directory for `vuepress build` command. ### temp - Type: `string` - Default: `` `${sourceDir}/.vuepress/.temp` `` - Details: Specify the directory for temporary files. ### cache - Type: `string` - Default: `` `${sourceDir}/.vuepress/.cache` `` - Details: Specify the directory for cache . ### public - Type: `string` - Default: `` `${sourceDir}/.vuepress/public` `` - Details: Specify the directory for public files. - Also see: - [Guide > Assets > Public Files](../guide/assets.md#public-files) ## Markdown Config ### markdown - Type: `MarkdownOptions` - Default: `{}` - Details: Configure VuePress built-in Markdown syntax extensions. - Also see: - [Guide > Markdown > Syntax Extensions](../guide/markdown.md#syntax-extensions) #### markdown.anchor - Type: `AnchorPluginOptions | false` - Details: Options for [markdown-it-anchor](https://github.com/valeriangalliat/markdown-it-anchor). Set to `false` to disable this plugin. - Also see: - [Guide > Markdown > Syntax Extensions > Header Anchors](../guide/markdown.md#header-anchors) #### markdown.assets - Type: `AssetsPluginOptions | false` - Details: Options for VuePress built-in markdown-it assets plugin. Set to `false` to disable this plugin. ::: danger You should not configure it unless you understand what it is for. ::: #### markdown.code - Type: `CodePluginOptions | false` - Details: Options for VuePress built-in markdown-it code plugin. Set to `false` to disable this plugin. - Also see: - [Guide > Markdown > Syntax Extensions > Code Blocks](../guide/markdown.md#code-blocks) ##### markdown.code.highlight - Type: `boolean` - Default: `true` - Details: Enable code syntax highlighting or not. You can disable it if you want to implement client side highlighting by yourself. For example, [Prismjs](https://prismjs.com/) or [highlight.js](https://highlightjs.org/). - Also see: - [Guide > Markdown > Syntax Extensions > Code Blocks > Syntax Highlighting](../guide/markdown.md#syntax-highlighting) ##### markdown.code.highlightLines - Type: `boolean` - Default: `true` - Details: Enable code line highlighting or not. - Also see: - [Guide > Markdown > Syntax Extensions > Code Blocks > Line Highlighting](../guide/markdown.md#line-highlighting) ##### markdown.code.lineNumbers - Type: `boolean` - Default: `true` - Details: Enable code line numbers or not. - Also see: - [Guide > Markdown > Syntax Extensions > Code Blocks > Line Numbers](../guide/markdown.md#line-numbers) ##### markdown.code.preWrapper - Type: `boolean` - Default: `true` - Details: Enable the extra wrapper of the `

` tag or not.

  The wrapper is required by the `highlightLines` and `lineNumbers`. That means, if you disable `preWrapper`, the line highlighting and line numbers will also be disabled.

  You can disable it if you want to implement them in client side. For example, [Prismjs Line Highlight](https://prismjs.com/plugins/line-highlight/) or [Prismjs Line Numbers](https://prismjs.com/plugins/line-numbers/).

##### markdown.code.vPre

- Type: `boolean`

- Default: `true`

- Details:

  Enable the `v-pre` directive on `` tag or not.

- Also see:
  - [Guide > Markdown > Syntax Extensions > Code Blocks > Wrap with v-pre](../guide/markdown.md#wrap-with-v-pre)

#### markdown.customComponent

- Type: `undefined | false`

- Details:

  Options for VuePress built-in markdown-it custom-component plugin.

  Set to `false` to disable this plugin.

::: danger
You should not configure it unless you understand what it is for.
:::

#### markdown.emoji

- Type: `EmojiPluginOptions | false`

- Details:

  Options for [markdown-it-emoji](https://github.com/markdown-it/markdown-it-emoji).

  Set to `false` to disable this plugin.

- Also see:
  - [Guide > Markdown > Syntax Extensions > Emoji](../guide/markdown.md#emoji)

#### markdown.extractHeaders

- Type: `ExtractHeadersPluginOptions | false`

- Details:

  Options for VuePress built-in markdown-it extract-headers plugin.

  It will extract page headers to page data, which will be used for generating sidebar, table of contents, etc. For example, the sidebar of current page is auto generated from the headers that extracted by this plugin.

  Set to `false` to disable this plugin.

#### markdown.hoistTags

- Type: `HoistTagsPluginOptions | false`

- Details:

  Options for VuePress built-in markdown-it hoist-tags plugin.

  It will hoist specific HTML tags in your Markdown to the top-level of SFC. By default, only `