跳至主要內容

其他插件选项

大约 3 分钟配置插件选项主题配置

autoCatalog

控制 vuepress-plugin-auto-catalog,提供目录的自动生成。

该插件默认启用。

相关信息

有关插件选项,请参阅 auto-catalog 插件选项

components

控制 vuepress-plugin-components,为 Markdown 提供一组组件。

可以在 Markdown 中使用的可用组件为:

  • "ArtPlayer"
  • "Badge"
  • "BiliBili"
  • "CodePen"
  • "FontIcon"
  • "PDF"
  • "Replit"
  • "Share"
  • "StackBlitz"
  • "VPBanner"
  • "VPCard"
  • "VidStack"
  • "SiteInfo"
  • "XiGua"

你可以将 plugin.components.components 设置为需要的组件数组,默认情况下为 ["Badge"]

同时,你可以设置 plugin.components.rootComponents 来启用一些根组件,例如 Notice。

相关信息

插件选项请参见 components 插件选项

copyCode 默认启用

控制 vuepress-plugin-copy-code2,提供代码复制按钮。

默认情况下,不需要任何配置。如果你不需要这个功能,请设置为 false

相关信息

插件选项请参见 copy-code2 插件选项

git 默认仅限构建模式

控制 @vuepress/plugin-git,通过 Git 提交历史提供文件信息。

默认情况下,为了提高开发服务器性能仅在构建模式下启用。你可以手动设置一个布尔值控制插件状态,可以设置插件选项。

相关信息

插件选项请参见 git 插件选项open in new window

nprogress 默认启用

控制 @vuepress/plugin-nprogress,通过 nprogress 提供切换页面时的进度条。

默认情况下,主题会启用此插件,你可以设置 false 禁用它。

prismjs 默认启用

控制 @vuepress/plugin-prismjs,通过 PrismJS 提供代码块高亮。

默认情况下,主题会启用此插件,你可以设置 false 禁用它并自行高亮代码块。

prismjs.light

日间模式使用的 Prism.js 主题

prismjs.dark

夜间模式使用的 Prism.js 主题

photoSwipe 默认启用

控制 vuepress-plugin-photo-swipe,提供图片浏览功能。

默认情况下,不需要任何配置。如果你不需要这个功能,请设置为 false

相关信息

插件选项请参见 photo-swipe 插件选项

readingTime 默认启用

控制 vuepress-plugin-reading-time2,为页面进行字数统计并生成预计的阅读时间。

readingTime.wordPerMinute

  • 类型: number
  • 默认值: 300

每分钟的阅读字数。

相关信息

更多插件选项请参见 reading-time2 插件文档

seo 默认启用

控制 vuepress-plugin-seo2,提供搜索引擎增强。

默认情况下,不需要任何配置。如果你不需要这个功能,请设置为 false

相关信息

插件选项请参见 seo2 插件选项

sitemap 默认启用

控制 vuepress-plugin-sitemap2,为网站自动生成 Sitemap。

默认情况下,不需要任何配置。如果你不需要这个功能,请设置为 false

相关信息

插件选项请参见 sitemap2 插件选项