Other Plugin Config

Options

backToTopenabled-by-default: Yes

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

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

Check back-to-top plugin docs for available plugin options.

catalogenabled-by-default: Yes

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

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

Check catalog plugin docs 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:

• Badge: Colorful badge component
• CodePen: Embedded CodePen demo
• Share: Sharing current page with social medias
• StackBlitz: Embedded StackBlitz demo
• SiteInfo: Display sites
• VPBanner: A banner component
• VPCard: A card component

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 docs for available plugin options.

Tips

The media components are moved to @vuepress/plugin-media.

copyCodeenabled-by-default: Yes

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

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

Check copy-code plugin docs for available plugin options.

gitenabled-in-production: Yes

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 docs for available plugin options.

media

Controls @vuepress/plugin-media which provides components to embed videos, audios and PDF documents.

The plugin is disabled by default, you need to set plugins.media with plugin options to enable it.

Check media plugin docs for available plugin options, and Media for instructions.

nprogressenabled-by-default: Yes

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

You can set false to disable it.

photoSwipeenabled-by-default: Yes

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

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

Check photo-swipe plugin docs 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 docs for available plugin options.

readingTimeenabled-by-default: Yes

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

Check reading-time plugin docs for available plugin options.

readingTime.wordPerMinutenumber

Default300

Reading speed (words per minute).

redirectenabled-by-default: Yes

Controls @vuepress/plugin-redirect which provides redirect support.

The default option of theme is { switchLocale: 'modal' }, set it to false if you don't need it.

Check redirect plugin docs for available plugin options.

seoenabled-by-default: Yes

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

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

Check seo plugin docs for available plugin options.

sitemapenabled-by-default: Yes

Controls @vuepress/plugin-sitemap which provides sitemap.

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

Check sitemap plugin docs for available plugin options.

watermark

Controls @vuepress/plugin-watermark which provides watermark.

Check watermark plugin docs for available plugin options.