Introduction
The theme comes with built-in plugins that extend its numerous functionalities. You can configure these internal plugins through the plugins option.
Configuration
All plugins used internally by the theme are configured within the plugins field.
import { defineUserConfig } from 'vuepress'
import { plumeTheme } from 'vuepress-theme-plume'
export default defineUserConfig({
theme: plumeTheme({
plugins: {
// more options...
}
}),
})Configuration Entry Priority
The theme provides two configuration entry points for some plugin features:
- Recommended entry (top-level configuration): Options like
markdown,search,watermark, etc. These options support hot updates, meaning changes take effect without restarting the development server. - Low-level entry (under the
pluginsnamespace): Options likeplugins.markdownPower,plugins.search,plugins.watermark, etc. These are the raw plugin configurations and do not support hot updates.
It is recommended to use the top-level configuration entry unless you need more fine-grained plugin control. When both are configured, the top-level configuration takes priority.
Plugin List
- @vuepress/plugin-nprogress - Page loading progress bar
- @vuepress/plugin-photo-swipe - Image preview
- @vuepress/plugin-reading-time - Article reading time
- @vuepress/plugin-watermark - Article watermark
- @vuepress-plume/plugin-search - Local search
- @vuepress/plugin-docsearch - Algolia documentation search
- @vuepress/plugin-copy-code - Code copy
- @vuepress/plugin-shiki - Syntax highlighting
- @vuepress/plugin-comment - Article comments
- @vuepress/plugin-markdown-hint - Markdown hints
- @vuepress/plugin-markdown-image - Markdown images
- @vuepress/plugin-markdown-math - Markdown mathematical formulas
- @vuepress/plugin-markdown-include - Markdown file inclusion
- @vuepress/plugin-markdown-chart - Markdown charts chartjs / echarts / mermaid / flowchart / markmap / plantUML
- @vuepress/plugin-replace-assets - Asset link replacement
- vuepress-plugin-md-power - Markdown Power
- @vuepress/plugin-git - Git commit information
- @vuepress/plugin-cache - Page compilation cache
- @vuepress/plugin-seo - SEO optimization
- @vuepress/plugin-sitemap - Sitemap
Tips
You don't need to install these built-in plugins separately, nor should you add them to vuepress config > plugins. The theme has already handled their integration internally.
