VuePress

Config Reference

This project is sponsored by bit

Basic Config

base

  • Type: string
  • Default: /

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, for example, GitHub pages. If you plan to deploy your site to https://foo.github.io/bar/, then you should set base to "/bar/". It should always start and end with a slash.

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:

title

  • Type: string
  • Default: undefined

Title for the site. This will be the prefix for all page titles, and displayed in the navbar in the default theme.

description

  • Type: string
  • Default: undefined

Description for the site. This will render as a <meta> tag in the page HTML.

  • Type: Array
  • Default: []

Extra tags to inject into the page HTML <head>. You can specify each tag in the form of [tagName, { attrName: attrValue }, innerHTML?]. For example, to add a custom favicon:

module.exports = {
  head: [
    ['link', { rel: 'icon', href: '/logo.png' }]
  ]
}

host

  • Type: string
  • Default: '0.0.0.0'

Specify the host to use for the dev server.

port

  • Type: number
  • Default: 8080

Specify the port to use for the dev server.

temp

  • Type: string
  • Default: /path/to/@vuepress/core/.temp

Specify the temporary directory for client.

dest

  • Type: string
  • Default: .vuepress/dist

Specify the output directory for vuepress build. If a relative path is specified, it will be resolved based on process.cwd().

locales

  • Type: { [path: string]: Object }
  • Default: undefined

Specify locales for i18n support. For more details, see the guide on Internationalization.

shouldPrefetch

  • Type: Function
  • Default: () => true

A function to control what files should have <link rel="preload"> resource hints generated. See shouldPrefetch.

cache

  • Type: boolean|string
  • Default: true

VuePress uses cache-loader by default to greatly speed up the compilation of webpack.

You can use this option to specify the path to the cache, and can also remove the cache before each build by setting it to false.

You can also use this option through the CLI:

vuepress dev docs --cache .cache # set cache path
vuepress dev docs --no-cache     # remove cache before each build.

extraWatchFiles

  • Type: Array
  • Default: []

Specify extra files to watch.

You can watch any file if you want. File changes will trigger vuepress rebuilding and real-time updates.

module.exports = {
  extraWatchFiles: [
    '.vuepress/foo.js', // Relative path usage
    '/path/to/bar.js'   // Absolute path usage
  ]
}

patterns

  • Type: Array
  • Default: ['**/*.md', '**/*.vue']

Specify which pattern of files you want to be resolved.

Styling

palette.styl

To apply simple color overrides to the styling of the default preset or define some color variables for using later, you can create a .vuepress/styles/palette.styl file.

There are some color variables you can tweak:

// showing default values
$accentColor = #3eaf7c
$textColor = #2c3e50
$borderColor = #eaecef
$codeBgColor = #282c34

Note

You should ONLY write color variables in this file. Since palette.styl will be imported at the end of the root Stylus config file, as a config, several files will use it, so once you wrote styles here, your style would be duplicated by multiple times.

index.styl

VuePress provides a convenient way to add extra styles. You can create a .vuepress/styles/index.styl file for that. This is a Stylus file but you can use normal CSS syntax as well.

.content {
  font-size 30px
}

Also see:

Theming

theme

  • Type: string
  • Default: undefined

Specify this to use a custom theme.

Also see:

themeConfig

  • Type: Object
  • Default: {}

Provide config options to the used theme. The options will vary depending on the theme you are using.

Also see:

Pluggable

plugins

  • Type: Object|Array
  • Default: undefined

Please check out Plugin > Using a plugin to learn how to use a plugin.

Markdown

markdown.lineNumbers

  • Type: boolean
  • Default: undefined

Whether to show line numbers to the left of each code blocks.

Also see:

markdown.slugify

Function for transforming header texts into slugs. Changing this affects the ids/links generated for header anchors, table of contents and sidebar links.

markdown.anchor

  • Type: Object
  • Default: { permalink: true, permalinkBefore: true, permalinkSymbol: '#' }

Options for markdown-it-anchor. (Note: prefer markdown.slugify to customize header ids.)

  • Type: Object
  • Default: { target: '_blank', rel: 'noopener noreferrer' }

The key and value pair will be added to <a> tags that point to an external link. The default option will open external links in a new window.

markdown.toc

  • Type: Object
  • Default: { includeLevel: [2, 3] }

Options for markdown-it-table-of-contents. (Note: prefer markdown.slugify to customize header ids.)

markdown.plugins

You can install any markdown-it plugins through markdown.plugins option. It’s similar with using VuePress plugins. You can either use Babel style or object style. The markdown-it- prefix is optional and can omit in the list.

module.exports = {
  markdown: {
    plugins: [
      '@org/foo', // equals to @org/markdown-it-foo if exists
      ['markdown-it-bar', {
        // provide options here
      }]
    ]
  }
}

Or

module.exports = {
  markdown: {
    plugins: {
      '@org/foo': {}
      'markdown-it-bar': {
        // provide options here
      }
    }
  }
}

markdown.extendMarkdown

  • Type: Function
  • Default: undefined

A function to edit default config or apply extra plugins to the markdown-it instance used to render source files. For example:

module.exports = {
  markdown: {
    extendMarkdown: md => {
      md.set({ breaks: true })
      md.use(require('markdown-it-xxx'))
    }
  }
}

This option is also included in Plugin API.

Build Pipeline

Configuring CSS Pre-processors

VuePress comes with built-in webpack config for the CSS pre-processors listed below. For more information on installation these or pre-processors without built-in support, see Using Pre-Processors for more information.

postcss

  • Type: Object
  • Default: { plugins: [require('autoprefixer')] }

Options for postcss-loader. Note specifying this value will overwrite autoprefixer and you will need to include it yourself.

Stylus

  • Type: Object
  • Default: { preferPathResolver: 'webpack' }

Options for stylus-loader.

scss

  • Type: Object
  • Default: {}

Options for sass-loader to load *.scss files.

Sass

  • Type: Object
  • Default: { indentedSyntax: true }

Options for sass-loader to load *.sass files.

less

  • Type: Object
  • Default: {}

Options for less-loader.

configureWebpack

  • Type: Object | Function
  • Default: undefined

Edit the internal webpack config. If the value is an Object, it will be merged into the final config using webpack-merge; If the value is a function, it will receive the config as the 1st argument and an isServer flag as the 2nd argument. You can either mutate the config directly, or return an object to merge:

module.exports = {
  configureWebpack: (config, isServer) => {
    if (!isServer) {
      // mutate the config for client
    }
  }
}

chainWebpack

  • Type: Function
  • Default: undefined

Edit the internal webpack config with webpack-chain.

module.exports = {
  chainWebpack: (config, isServer) => {
    // config is an instance of ChainableConfig
  }
}

Browser Compatibility

evergreen

  • Type: boolean | Function
  • Default: false

Set to true if you are only targeting evergreen browsers. This will disable ES5 transpilation and polyfills for IE, and result in faster builds and smaller files.