Skip to main content

Theme Plugins

About 2 minConfigIntroPlugin ConfigTheme Config

vuepress-theme-hope bundles many VuePress plugins and adds support for more VuePress plugin.

Plugin Options

The theme provides plugins option to pass options to plugins.

Plugin Options Name

All key names in plugins option are the camelCase version of the plugin name, with the optional number 2 suffix removed.

For example:

  • @vuepress/plugin-copy-code is controlled by key name copyCode.
  • @vuepress/plugin-copyright is controlled by key name copyright.
  • vuepress-plugin-md-enhance is controlled by key name mdEnhance.

Plugin List

Internal Plugins

The following plugins are used internally and can not be disabled:

Automatically Enabled Plugins

The following plugins are enabled by default, and you can disable them:

Plugins that need to be enabled manually

The following plugins are bundled by theme, you can enable them via configuration:

Plugins with Built-in Support

These plugins are supported by theme, but you need to install them manually while using: