VuePress 生态系统VuePress 生态系统
  • 主题指南
  • 默认主题
  • Hope 主题
  • Plume 主题
  • Reco 主题
  • 功能插件
  • Markdown 插件
  • 搜索插件
  • 博客插件
  • 渐进式应用插件
  • 统计分析插件
  • 搜索引擎优化插件
  • 开发插件
  • 工具插件
  • AI 插件
  • @vuepress/helper
  • English
  • 简体中文
GitHub
  • 主题指南
  • 默认主题
  • Hope 主题
  • Plume 主题
  • Reco 主题
  • 功能插件
  • Markdown 插件
  • 搜索插件
  • 博客插件
  • 渐进式应用插件
  • 统计分析插件
  • 搜索引擎优化插件
  • 开发插件
  • 工具插件
  • AI 插件
  • @vuepress/helper
  • English
  • 简体中文
GitHub
  • 主题指南
  • 默认主题
    • 配置
    • 插件配置
    • 语言配置
    • Frontmatter
    • 内置组件
    • Markdown
    • 样式
    • 继承
  • Hope 主题
  • Plume 主题
  • Reco 主题

插件配置

你可以通过 themePlugins 设置默认主题使用的插件。

默认主题使用了一些插件,如果你确实不需要该插件,你可以选择禁用它。在禁用插件之前,请确保你已了解它的用途。

.vuepress/config.ts
import { defaultTheme } from '@vuepress/theme-default'

export default {
  theme: defaultTheme({
    themePlugins: {
      // 在这里自定义主题插件
    },
  }),
}

themePlugins.activeHeaderLinks

  • 类型: boolean

  • 默认值: true

  • 详情:

    是否启用 @vuepress/plugin-active-header-links 。

themePlugins.backToTop

  • 类型: BackToTopPluginOptions | boolean

  • 默认值: true

  • 详情:

    是否启用 @vuepress/plugin-back-to-top 。

    支持对象格式以作为插件选项。

themePlugins.container

  • 类型: Record<ContainerType, boolean>

  • 详情:

    是否启用由 @vuepress/plugin-markdown-container 支持的自定义容器。

    ContainerType 类型为:

    • codeGroup
    • codeGroupItem
  • 参考:

    • 默认主题 > Markdown > 自定义容器

themePlugins.copyCode

  • 类型: CopyCodePluginOptions | boolean

  • 默认值: true

  • 详情:

    是否启用 @vuepress/plugin-copy-code。

    支持对象格式以作为插件选项。

themePlugins.git

  • 类型: boolean

  • 默认值: true

  • 详情:

    是否启用 @vuepress/plugin-git 。

themePlugins.hint

  • 类型: MarkdownHintPluginOptions | boolean

  • 默认值: true

  • 详情:

    是否启用 @vuepress/plugin-markdown-hint。

  • 参考:

    • 默认主题 > Markdown > 提示容器

themePlugins.links-check

  • 类型: boolean

  • 默认值: true

  • 详情:

    是否启用 @vuepress/plugin-links-check 。

themePlugins.mediumZoom

  • 类型: boolean

  • 默认值: true

  • 详情:

    是否启用 @vuepress/plugin-medium-zoom 。

themePlugins.nprogress

  • 类型: boolean

  • 默认值: true

  • 详情:

    是否启用 @vuepress/plugin-nprogress 。

themePlugins.prismjs

  • 类型: boolean

  • 默认值: true

  • 详情:

    是否启用 @vuepress/plugin-prismjs 。

themePlugins.seo

  • 类型: SeoPluginOptions | boolean

  • 默认值: true

  • 详情:

    是否启用 @vuepress/plugin-seo 。

    支持对象格式以作为插件选项。

themePlugins.sitemap

  • 类型: SitemapPluginOptions | boolean

  • 默认值: true

  • 详情:

    是否启用 @vuepress/plugin-sitemap 。

    支持对象格式以作为插件选项。

themePlugins.tab

  • 类型: MarkdownTabPluginOptions | boolean

  • 默认值: true

  • 详情:

    是否启用 @vuepress/plugin-markdown-tab。

  • 参考:

    • 默认主题 > Markdown > 代码选项卡
    • 默认主题 > Markdown > 选项卡
在 GitHub 上编辑此页
上次更新: 2025/4/12 19:03
贡献者: Mister-Hope, 张怀文
上一页
配置
下一页
语言配置