Plugins Config

You can configure the plugins that used by default theme with themePlugins.

Default theme is using some plugins by default. You can disable a plugin if you really do not want to use it. Make sure you understand what the plugin is for before disabling it.

.vuepress/config.ts
import { defaultTheme } from '@vuepress/theme-default'

export default {
  theme: defaultTheme({
    themePlugins: {
      // customize theme plugins here
    },
  }),
}

themePlugins

activeHeaderLinksboolean

Defaulttrue

Enable @vuepress/plugin-active-header-links or not.

backToTopBackToTopPluginOptions | boolean

Defaulttrue

Enable @vuepress/plugin-back-to-top or not.

Object value is supported as plugin options.

copyCodeCopyCodePluginOptions | boolean

Defaulttrue

Enable @vuepress/plugin-copy-code or not.

Object value is supported as plugin options.

gitGitPluginOptions | boolean

Defaulttrue

Enable @vuepress/plugin-git or not.

hintMarkdownHintPluginOptions | boolean

Defaulttrue

Enable @vuepress/plugin-markdown-hint or not.

See also: Hint Containers

linksCheckLinksCheckPluginOptions | boolean

Defaulttrue

Enable @vuepress/plugin-links-check or not.

Object value is supported as plugin options.

mediumZoomboolean

Defaulttrue

Enable @vuepress/plugin-medium-zoom or not.

nprogressboolean

Defaulttrue

Enable @vuepress/plugin-nprogress or not.

prismjsPrismjsPluginOptions | boolean

Defaulttrue

Enable @vuepress/plugin-prismjs or not.

seoPartial<SeoPluginOptions> | boolean

Defaulttrue

Enable @vuepress/plugin-seo or not.

Object value is supported as plugin options.

sitemapPartial<SitemapPluginOptions> | boolean

Defaulttrue

Enable @vuepress/plugin-sitemap or not.

Object value is supported as plugin options.

tabMarkdownTabPluginOptions | boolean

Defaulttrue

Enable @vuepress/plugin-markdown-tab or not.

See also: Code Tabs and Tabs