VuePress 生态系统VuePress 生态系统
  • 主题指南
  • 默认主题
  • Hope 主题
  • Plume 主题
  • Reco 主题
  • 功能插件
  • Markdown 插件
  • 搜索插件
  • 博客插件
  • 渐进式应用插件
  • 统计分析插件
  • 搜索引擎优化插件
  • 开发插件
  • 工具插件
  • AI 插件
  • @vuepress/helper
  • English
  • 简体中文
GitHub
  • 主题指南
  • 默认主题
  • Hope 主题
  • Plume 主题
  • Reco 主题
  • 功能插件
  • Markdown 插件
  • 搜索插件
  • 博客插件
  • 渐进式应用插件
  • 统计分析插件
  • 搜索引擎优化插件
  • 开发插件
  • 工具插件
  • AI 插件
  • @vuepress/helper
  • English
  • 简体中文
GitHub
  • 搜索插件指南
  • docsearch
  • meilisearch
  • search
  • slimsearch

搜索插件指南

为了使 VuePress 主题开箱即用地支持搜索插件,我们有一套创建搜索插件时应遵循的指南。

组件名称

  • 如果搜索插件提供了适合在导航栏或侧边栏中显示的搜索框,则应将其命名为 <SearchBox /> 并进行全局注册。

  • 如果搜索插件提供了适合在单个页面中显示的复杂搜索结果组件(包含输入和结果列表),则应将其命名为 <SearchPanel /> 并进行全局注册。

    搜索插件应在每个语言环境中自动生成一个包含 <SearchPanel /> 组件的 /search.html 页面,但不得覆盖任何现有页面。

在 GitHub 上编辑此页
上次更新: 2025/1/10 18:07
贡献者: Mister-Hope
Next
docsearch