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.

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

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

themePlugins.activeHeaderLinks

• Type: boolean

• Default: true

• Details:

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

themePlugins.backToTop

• Type: BackToTopPluginOptions | boolean

• Default: true

• Details:

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

  Object value is supported as plugin options.

themePlugins.container

• Type: Record<ContainerType, boolean>

• Details:

  Enable custom containers that powered by @vuepress/plugin-markdown-container or not.

  ContainerType type is:

  • codeGroup
  • codeGroupItem

• Also see:

  • Default Theme > Markdown > Custom Containers

themePlugins.copyCode

• Type: CopyCodePluginOptions | boolean

• Default: true

• Details:

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

  Object value is supported as plugin options.

themePlugins.git

• Type: boolean

• Default: true

• Details:

  Enable @vuepress/plugin-git or not.

themePlugins.hint

• Type: MarkdownHintPluginOptions | boolean

• Default: true

• Details:

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

• Also see:

  • Default Theme > Markdown > Hint Containers

themePlugins.linksCheck

• Type: LinksCheckPluginOptions | boolean

• Default: true

• Details:

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

themePlugins.mediumZoom

• Type: boolean

• Default: true

• Details:

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

themePlugins.nprogress

• Type: boolean

• Default: true

• Details:

  Enable @vuepress/plugin-nprogress or not.

themePlugins.prismjs

• Type: boolean

• Default: true

• Details:

  Enable @vuepress/plugin-prismjs or not.

themePlugins.seo

• Type: SeoPluginOptions | boolean

• Default: true

• Details:

  Enable @vuepress/plugin-seo or not.

  Object value is supported as plugin options.

themePlugins.sitemap

• Type: SitemapPluginOptions | boolean

• Default: true

• Details:

  Enable @vuepress/plugin-sitemap or not.

  Object value is supported as plugin options.

themePlugins.tab

• Type: MarkdownTabPluginOptions | boolean

• Default: true

• Details:

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

• Also see:

  • Default Theme > Markdown > Code Tabs
  • Default Theme > Markdown > Tabs