Theme Plugins

vuepress-theme-hope bundles many VuePress plugins and adds support for more VuePress plugin.

Plugin Options

The theme provides plugins option to pass options to plugins.

Plugin Options Name

All key names in plugins option are the camelCase version of the plugin name, with the optional number 2 suffix removed.

For example:

• @vuepress/plugin-copy-code is controlled by key name copyCode.
• @vuepress/plugin-copyright is controlled by key name copyright.
• vuepress-plugin-md-enhance is controlled by key name mdEnhance.

Plugin List

Internal Plugins

The following plugins are used internally with core functionality and can not be disabled:

• @vuepress/plugin-sass-palette: Sass plugin for plugins and themes

• @vuepress/plugin-theme-data: Composition API plugin for theme data

Automatically Enabled Plugins

The following plugins are bundled and enabled by default, and you can disable them:

• @vuepress/plugin-active-header-links: Automatically update route hash based on current header (plugins.activeHeaderLinks)

• @vuepress/plugin-back-to-top: Provides back to top button (plugins.backToTop)

• @vuepress/plugin-catalog: Provides catalog page generation and <Catalog /> component (plugins.catalog)

• @vuepress/plugin-copy-code: Provides copy button for code blocks (plugins.copyCode)

• @vuepress/plugin-git: Git-based info plugin (plugins.git)

• @vuepress/plugin-icon: Icon support (plugins.icon)

• @vuepress/plugin-links-check: Check links in markdown files (markdown.linksCheck)

• @vuepress/plugin-markdown-chart: Chart and diagram support (markdown.chartjs, markdown.echarts, markdown.flowchart, markdown.markmap, markdown.mermaid, markdown.plantuml)

• @vuepress/plugin-markdown-ext: GFM support and other general Markdown syntax (markdown.gfm, markdown.breaks, markdown.linkify, markdown.footnote, markdown.tasklist, markdown.component, markdown.vPre, markdown.cjkFriendly)

• @vuepress/plugin-markdown-hint: Markdown hint containers (markdown.hint, markdown.alert)

• @vuepress/plugin-markdown-image: Markdown image enhancement (markdown.figure, markdown.imgLazyload, markdown.imgMark, markdown.imgSize, markdown.obsidianImgSize)

• @vuepress/plugin-markdown-include: Markdown file import (markdown.include)

• @vuepress/plugin-markdown-stylize: Markdown content stylize (markdown.align, markdown.attrs, markdown.layout, markdown.mark, markdown.spoiler, markdown.steps, markdown.sup, markdown.sub, markdown.stylize)

• @vuepress/plugin-markdown-tab: Tabs and code tabs (markdown.tabs, markdown.codeTabs)

• @vuepress/plugin-nprogress: Progress bar (plugins.nprogress)

• @vuepress/plugin-photo-swipe: Image preview plugin based on photo-swipe (plugins.photoSwipe)

• @vuepress/plugin-reading-time: Reading time and word count (plugins.readingTime)

• @vuepress/plugin-seo: SEO enhancement plugin (plugins.seo)

• @vuepress/plugin-shiki: Code highlighting plugin using Shiki (markdown.highlighter)

• @vuepress/plugin-sitemap: Sitemap plugin (plugins.sitemap)

• vuepress-plugin-components: Provides common components out of the box (plugins.components).

Plugins that need to be enabled manually

The following plugins are bundled by theme, but they are disabled by default. You need to enable them via their options:

• @vuepress/plugin-blog: Blog plugin for VuePress2 (plugins.blog)

• @vuepress/plugin-comment: Provides comment and pageview function (plugins.comment)

• @vuepress/plugin-copyright: Append copyright information when copying or disable copy and selection (plugins.copyright)

• @vuepress/plugin-markdown-field: Field container support (markdown.fields)

• @vuepress/plugin-markdown-file-tree: File tree and code tree support (markdown.fileTree, markdown.codeTree)

• @vuepress/plugin-markdown-math: Formula support (markdown.math)

• @vuepress/plugin-markdown-preview: Markdown preview support (markdown.preview)

• @vuepress/plugin-media: Components to embed videos, audios and PDF documents (plugins.media)

• @vuepress/plugin-notice: Provides notice (plugins.notice)

• @vuepress/plugin-redirect: Redirect pages (plugins.redirect)

• @vuepress/plugin-rtl: Provides rtl support (set rtl: true in the needed theme locales)

• vuepress-plugin-md-enhance: Provides more Markdown syntax (markdown.demo, markdown.playground, markdown.kotlinPlayground, markdown.vuePlayground, markdown.sandpack)

Plugins with Built-in Support

These plugins are supported by theme, but they are not bundled. You need to install them manually, then enable them via their options:

• @vuepress/plugin-docsearch: Crawler based search plugin with DocSearch (plugins.docsearch)

• @vuepress/plugin-feed: Feed support (plugins.feed)

• @vuepress/plugin-meilisearch: Open source search plugin with MeiliSearch (plugins.meilisearch)

• @vuepress/plugin-orama: Client search plugin using Orama (plugins.orama)

• @vuepress/plugin-prismjs: Code highlighting plugin using Prism.js (markdown.highlighter)

• @vuepress/plugin-pwa: PWA support (plugins.pwa)

• @vuepress/plugin-revealjs: Presentation support (markdown.revealjs)

• @vuepress/plugin-search: Simple client search plugin (plugins.search)

  Deprecated

  Use @vuepress/plugin-slimsearch or @vuepress/plugin-orama instead.

• @vuepress/plugin-slimsearch: Client search plugin using SlimSearch (plugins.slimsearch)

• @vuepress/plugin-watermark: Watermark plugin (plugins.watermark)

• @vuepress/shiki-twoslash: TypeScript twoslash support for the Shiki highlighter (set the twoslash option of markdown.highlighter)