主题插件
vuepress-theme-hope
捆绑了很多 VuePress 插件并提供了更多 VuePress 插件支持。
插件选项
主题提供 plugins
选项向对应的插件传递所需选项。
插件选项名称
所有的配置键名均为插件名称的驼峰式 (camelCase) 版本,并去除名称中可能存在的数字 2 结尾。
例如:
@vuepress/plugin-copy-code
的配置键名为copyCode
。@vuepress/plugin-copyright
的配置键名为copyright
vuepress-plugin-md-enhance
的配置键名为mdEnhance
插件列表
内置插件
下列插件被内部调用,不可禁用:
@vuepress/plugin-sass-palette: 面向插件和主题的 Sass 配置插件
@vuepress/plugin-theme-data: 主题配置的 Composition API 插件
- vuepress-plugin-components
: 提供一些开箱即用的组件
自动启用的插件
下列插件默认启用,你可以禁用它们:
@vuepress/plugin-active-header-links: 自动更新路由 Hash
@vuepress/plugin-back-to-top: 返回顶部按钮
@vuepress/plugin-catalog: 提供目录页自动生成与
<Catalog />
组件@vuepress/plugin-copy-code: 为代码块提供复制按钮。
@vuepress/plugin-git: 基于 Git 的信息插件
@vuepress/plugin-links-check: 检查 Markdown 链接
@vuepress/plugin-markdown-hint: Markdown 提示容器
@vuepress/plugin-markdown-image: Markdown 图片增强
@vuepress/plugin-photo-swipe: 基于 Photo Swipe 的图片浏览插件
@vuepress/plugin-reading-time: 阅读时间与字数统计
@vuepress/plugin-seo: SEO 增强插件
@vuepress/plugin-shiki: 基于 Shiki 的代码高亮插件
@vuepress/plugin-sitemap: Sitemap 插件
- vuepress-plugin-md-enhance
: 提供更多 Markdown 语法
需要手动启用的插件
主题捆绑以下插件,你可以通过配置启用它们
@vuepress/plugin-blog: VuePress2 的博客插件
@vuepress/plugin-copyright: 在用户复制时追加版权信息,或禁用站点的复制与选择。
@vuepress/plugin-comment: 提供评论与浏览量功能
@vuepress/plugin-notice: 提供公告
@vuepress/plugin-rtl: 提供 RTL 支持
内置支持的插件
以下插件受到主题支持,但你需要在使用前自行安装它们:
@vuepress/plugin-docsearch: 基于 DocSearch 的搜索插件
@vuepress/plugin-search: 简单的客户端搜索插件
@vuepress/plugin-feed: Feed 支持
@vuepress/plugin-prismjs: 基于 prism.js 的代码高亮插件
@vuepress/plugin-redirect: 重定向插件
@vuepress/plugin-pwa: PWA 支持
- vuepress-plugin-search-pro
: 专业客户端搜索插件