Other Plugin Config
autoCatalog
Controls vuepress-plugin-auto-catalog
, providing automatic generation of catalog.
This plugin is enabled by default.
Info
For plugin options, please refer to auto catalog 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 plugin.components.components
with an array of components you want, by default it will be ["Badge"]
.
Also, you can set plugin.components.rootComponents
to enable some root components, such as Notice.
Info
For plugin options, please refer to components plugin options.
enabled by default
copyCodeControls vuepress-plugin-copy-code2
, providing a code copy button.
By default, no config is required. If you don't need this feature, please set to false
.
Info
For plugin options, please refer to copy-code2 plugin options.
enabled in production
gitControls @vuepress/plugin-git
to provide file information via Git commit history.
By default, it is only enabled in build mode to improve development server performance. You can manually set a boolean to control the plugin state, or provide plugin options.
Info
See git plugin options for plugin options.
enabled by default
nprogressControls @vuepress/plugin-nprogress
and provides a progress bar when switching pages through nprogress.
By default, the theme will enable this plugin, you can set false
to disable it.
enabled by default
prismjsControls @vuepress/plugin-prismjs
to provide code block highlighting via PrismJS.
By default, the theme will enable this plugin, you can set false
to disable it and highlight code blocks yourself.
prismjs.light
- Type:
PrismjsTheme
- Default:
"one-light"
- Details: Interface → Code Themes
Prism.js theme used in lightmode.
prismjs.dark
- Type:
PrismjsTheme
- Default:
"one-dark"
- Details: Interface → Code Themes
Prism.js theme used in darkmode.
enabled by default
photoSwipeControls vuepress-plugin-photo-swipe
, providing picture browsing function.
By default, no config is required. If you don't need this feature, please set to false
.
Info
For plugin options, please refer to photo-swipe plugin options.
enabled by default
readingTimeControls vuepress-plugin-reading-time2
, providing word count for a page and generate an estimated reading time.
readingTime.wordPerMinute
- Type:
number
- Default:
300
Words read per minute.
Info
For more plugin options, see reading-time2 plugin options.
enabled by default
seoControls vuepress-plugin-seo2
, providing search engine enhancements.
By default, no config is required. If you don't need this feature, please set to false
.
Info
For plugin config, see seo2 plugin options.
enabled by default
sitemapControls vuepress-plugin-seo2
, providing automatically Sitemap generation.
By default, no config is required. If you don't need this feature, please set to false
.
Info
For plugin config, please refer to sitemap2 plugin options.