# Option API

# name

Type: string
Default: undefined

The name of the plugin.

Internally, VuePress will use the plugin’s package name as the plugin name. When your plugin is a local plugin (that is using a pure plugin function directly), please be sure to configure this option, that is good for debug tracking.

// .vuepress/config.js
module.exports = {
  plugins: [
    [
      (pluginOptions, context) => ({
        name: 'my-xxx-plugin'
        // ... the rest of options
      })
    ]
  ]
}

# plugins

Type: array
Default: undefined

A plugin can contain several plugins like a preset.

// A plugin
module.exports = {
  plugins: [
    'tag',
    'category'
  ]
}

# chainWebpack

Type: Function
Default: undefined

Edit the internal webpack config with webpack-chain (opens new window).

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

TIP

Since VuePress is a Vue-SSR based application, there needs to be two webpack configurations, isServer is used to determine whether the current webpack config is applied to the server or client.

Also see:

Vue SSR > Build Configuration (opens new window)

# define

Type: Object|Function
Default: undefined

Since using DefinePlugin (opens new window) via chainWebpack would be a little complicated:

module.exports = {
  chainWebpack (config) {
    config.plugin('injections').tap(([options]) => [
      Object.assign(options, {
        SW_BASE_URL: JSON.stringify('/')
      })
    ])
  }
}

VuePress opened up a more concise define option, note that the values has been automatically processed by JSON.stringify.

Object Usage:

module.exports = {
  define: {
    SW_BASE_URL: '/',
  }
}

Function Usage:

module.exports = (options, context) => ({
  define () {
    return {
      SW_BASE_URL: context.base || '/',
      SW_ENABLED: !!options.enabled,
    }
  }
})

# alias

Type: Object|Function
Default: undefined

We can set aliases via chainWebpack:

module.exports = (options, context) => ({
  chainWebpack (config) {
    config.resolve.alias.set('@pwd', process.cwd())
  }
})

But alias option makes this process more like configuration:

module.exports = (options, context) => ({
  alias: {
    '@pwd': process.cwd()
  }
})

# beforeDevServer

Type: Function
Default: undefined

Equivalent to before (opens new window) in webpack-dev-server (opens new window). You can use it to define custom handlers before all middleware is executed:

module.exports = {
  // ...
  beforeDevServer(app, server) {
    app.get('/path/to/your/custom', function(req, res) {
      res.json({ custom: 'response' })
    })
  }
}

# afterDevServer

Type: Function
Default: undefined

Equivalent to after (opens new window) in webpack-dev-server (opens new window). You can use it to execute custom middleware after all other middleware:

module.exports = {
  // ...
  afterDevServer(app, server) {
    // hacking now ...
  }
}

# extendMarkdown

Type: Function
Default: undefined

A function to edit default config or apply extra plugins to the markdown-it (opens new window) instance used to render source files. Example:

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

# chainMarkdown

Type: Function
Default: undefined

Edit the internal Markdown config with markdown-it-chain (opens new window) —— A chaining API like webpack-chain (opens new window) but for markdown-it (opens new window).

module.exports = {
  chainMarkdown (config) {
    // Interact with 'options' in new MarkdownIt
    // Ref: https://markdown-it.github.io/markdown-it/#MarkdownIt.new
    config
      .options
        .link(true)
        .breaks(true)

    // Modify the arguments of internal plugin.
    config
      .plugin('anchor')
        .tap(([options]) => [
          Object.assign(options, { permalinkSymbol: '#' })
        ])

    // Add extra markdown-it plugin
    config
      .plugin('sup')
        .use(require('markdown-it-sup'))

    // Remove internal plugin
    config.plugins.delete('snippet')
  }
}

Also see:

# enhanceAppFiles

Type: String | Array | AsyncFunction
Default: undefined

This option accepts absolute file path(s) pointing to the enhancement file(s), or a function that returns the path(s), which allows you to do some App Level Enhancements.

import { resolve } from 'path'

module.exports = {
  enhanceAppFiles: resolve(__dirname, 'client.js')
}

This option also supports dynamic code which allows you to do more, with the ability to touch the compilation context:

module.exports = (option, context) => {
  return {
    enhanceAppFiles() {
      return {
         name: 'dynamic-code',
         content: `export default ({ Vue }) => { Vue.mixin('$source', '${
           context.sourceDir
         }') }`
       }
    }
  }
}

# clientDynamicModules

Type: Function
Default: undefined

Sometimes, you may want to generate some client modules at compile time.

module.exports = (options, context) => ({
  clientDynamicModules() {
    return {
      name: 'constants.js',
      content: `export const SOURCE_DIR = '${context.sourceDir}'`
    }
  }
})

Then you can use this module at client-side code by:

import { SOURCE_DIR } from '@dynamic/constants'

# extendPageData

Type: Function|AsyncFunction
Default: undefined

A function used to extend or edit the $page object. This function will be invoking once for each page at compile time.

module.exports = {
  extendPageData ($page) {
    const {
      _filePath,           // file's absolute path
      _computed,           // access the client global computed mixins at build time, e.g _computed.$localePath.
      _content,            // file's raw content string
      _strippedContent,    // file's content string without frontmatter
      key,                 // page's unique hash key
      frontmatter,         // page's frontmatter object
      regularPath,         // current page's default link (follow the file hierarchy)
      path,                // current page's real link (use regularPath when permalink does not exist)
    } = $page

    // 1. Add extra fields.
    $page.xxx = 'xxx'

    // 2. Change frontmatter.
    frontmatter.sidebar = 'auto'
  }
}

Note that extendPageData can also be defined as an asynchronous function.

module.exports = {
  async extendPageData ($page) {
    $page.xxx = await getAsyncData()
  }
}

Note

These fields starting with an _ means you can only access them during build time.

For example:

module.exports = {
  extendPageData ($page) {
    $page.size = ($page._content.length / 1024).toFixed(2) + 'kb'
  }
}

Then you can use this value via this.$page.size in any Vue component.

# clientRootMixin

Type: String
Default: undefined

A path to the mixin file which allows you to control the lifecycle of root component.

// plugin's entry
const path = require('path')

module.exports = {
  clientRootMixin: path.resolve(__dirname, 'mixin.js')
}

// mixin.js
export default {
  created () {},
  mounted () {}
}

# additionalPages

Type: Array|AsyncFunction
Default: undefined

Add a page pointing to a Markdown file:

const path = require('path')

module.exports = {
  additionalPages: [
    {
     path: '/readme/',
     filePath: path.resolve(__dirname, '../../README.md')
    }
  ]
}

Add a page with explicit content:

module.exports = {
  async additionalPages () {
    // Note that VuePress doesn't have request library built-in
    // you need to install it yourself.
    const rp = require('request-promise')
    const content = await rp('https://raw.githubusercontent.com/vuejs/vuepress/master/CHANGELOG.md')
    return [
      {
        path: '/changelog/',
        content
      }
    ]
  }
}

Add a pure route:

module.exports = {
  additionalPages: [
    {
       path: '/alpha/',
       frontmatter: {
          layout: 'MyLayout'
       }
    }
  ]
}

# globalUIComponents

Type: Array|String
Default: undefined

You might want to inject some global UI fixed somewhere on the page, for example back-to-top, popup. In VuePress, a global UI is a Vue component, you can directly define the component’s name(s) in this option, for example:

module.exports = {
  globalUIComponents: [
    'Component-1',
    'Component-2'
  ]
}

Then, VuePress will automatically inject these components behind the layout component:

<div id="app">
  <div class="theme-container"> ... </div> <!-- Layout Component -->
  <div class="global-ui">
    <Component-1/>
    <Component-2/>
  </div>
</div>

# extendCli

Type: function
Default: undefined

Register a extra command to enhance the CLI of VuePress. The function will be called with a CAC (opens new window)'s instance as the first argument.

module.exports = {
  extendCli (cli) {
    cli
      .command('info [targetDir]', '')
      .option('--debug', 'display info in debug mode')
      .action((dir = '.') => {
        console.log('Display info of your website')
      })
  }
}

Now you can use vuepress info [targetDir] a in your project!

TIP

Note that a custom command registered by a plugin requires VuePress to locate your site configuration like vuepress dev and vuepress build, so when developing a command, be sure to lead the user to pass targetDir as an CLI argument.

← Lifecycle Context API →