Skip to main content

Other Plugin Config

About 2 minConfigPlugin ConfigTheme Config

catalog enabled by default

Controls @vuepress/plugin-catalog which provides catalog pages generation.

No extra config is required by default. Se it to false if you don't need it.

Check catalog plugin docsopen in new window for available plugin options.

backToTop enabled by default

Controls @vuepress/plugin-back-to-top which provides a back to top button.

No extra config is required by default. Se it to false if you don't need it.

Check back-to-top plugin docsopen in new window for available plugin options.

components

Controls vuepress-plugin-components, providing a set of components for Markdown.

Available component which can be used in markdown files are:

  • "ArtPlayer"
  • "Badge"
  • "BiliBili"
  • "CodePen"
  • "FontIcon"
  • "PDF"
  • "Replit"
  • "Share"
  • "StackBlitz"
  • "VPBanner"
  • "VPCard"
  • "VidStack"
  • "SiteInfo"
  • "XiGua"

You can set plugins.components.components with an array of components you want, by default it will be ["Badge"].

Also, you can set plugins.components.rootComponents to enable some root components, such as Notice.

Check components plugin docsopen in new window for available plugin options.

copyCode enabled by default

Controls @vuepress/plugin-copy-code which provides a code copy button on desktop.

No extra config is required by default. Se it to false if you don't need it.

Check copy-code plugin docsopen in new window for available plugin options.

externalLinkIcon enabled by default

Controls whether enable @vuepress/external-link-icon or not, only accept boolean value.

git enabled in production

Controls @vuepress/plugin-git which provides page meta via Git.

The plugin is only enabled in build mode by default to improve devServer performance. You can manually set a boolean to control the plugin state, or provide plugin options.

Check git plugin docsopen in new window for available plugin options.

linksCheck enabled by default

Controls @vuepress/plugin-links-check which provides markdown links check. You can manually set a boolean to control the plugin state, or provide plugin options.

Check links-check plugin docsopen in new window for available plugin options.

nprogress enabled by default

Controls @vuepress/plugin-nprogress which provides a progress bar through nprogress when switching pages .

You can set false to disable it.

prismjs enabled by default

Controls @vuepress/plugin-prismjs which provides code block highlighting via prismjs.

You can set false to disable it and highlight code blocks yourself or with other plugins.

prismjs.light

Prism.js theme used in lightmode.

prismjs.dark

Prism.js theme used in darkmode.

photoSwipe enabled by default

Controls @vuepress/plugin-photo-swipe which provides picture browsing feature.

No extra config is required by default. Se it to false if you don't need it.

Check photo-swipe plugin docsopen in new window for available plugin options.

pwa

Controls @vuepress/plugin-pwa which provides PWA support.

You can set true to directly enable it, or provide plugin options.

Check pwa plugin docsopen in new window for available plugin options.

readingTime enabled by default

Controls @vuepress/plugin-reading-time which generates words count and estimated reading time for pages.

readingTime.wordPerMinute

  • Type: number
  • Default: 300

Reading speed (words per minute)

Check reading-time plugin docsopen in new window for available plugin options.

seo enabled by default

Controls @vuepress/plugin-seo which provides search engine enhancements.

No extra config is required by default. Se it to false if you don't need it.

Check seo plugin docsopen in new window for available plugin options.

sitemap enabled by default

Controls @vuepress/plugin-sitemap which provides sitemap.

No extra config is required by default. Se it to false if you don't need it.

Check sitemap plugin docsopen in new window for available plugin options.