Using a Plugin

A plugin can be published on npm in CommonJS format as vuepress-plugin-xxx. You can use it:

module.exports = {
  plugins: [ 'vuepress-plugin-xxx' ]
}

If you prefix the plugin with vuepress-plugin-, you can use a shorthand to leave out that prefix:

module.exports = {

Same with:

module.exports = {
  plugins: [ '@org/vuepress-plugin-xxx', '@vuepress/plugin-xxx' ]
}

Shorthand:

module.exports = {
  plugins: [ '@org/xxx', '@vuepress/xxx' ]
}

Note

The plugin whose name starts with @vuepress/plugin- is an officially maintained plugin.

Since this style is consistent with babel’s Plugin/Preset Options, we call it Babel Style.

VuePress also provides a simpler way to use plugins from a dependency:


  plugins: {
  }
}

Note

module.exports = {
  plugins: [
    [ 'xxx', false ] // disabled.
}