@docmd/plugin-search 插件为您的文档网站提供客户端搜索体验。它在编译期间使用 MiniSearch 构建压缩索引，使读者能够即时搜索技术文档，无需服务端数据库或第三方爬虫服务。

配置选项

搜索在标准 docmd 模板中默认启用。在 docmd.config.json 中配置索引器参数和标头位置：

标头集成示例

{
  "layout": {
    "optionsMenu": {
      "position": "header",
      "components": {
        "search": true
      }
    }
  }
}

关键词搜索的工作原理

1. 构建期索引

在站点编译期间（npx @docmd/core build），@docmd/plugin-search 遍历站点上的每个页面。它提取标题、各级标题和正文文本，生成压缩的 search-index.json 包：

• 深度链接: 将标题锚点（#、##）注册为直接搜索跳转目标。
• 相关性权重: 页面标题获得最高权重，其次是章节标题，然后是正文段落。

2. 客户端检索

当用户打开搜索模态框（按 Ctrl+K 或 /）时，浏览器会获取 search-index.json。查询在本地执行，支持前缀匹配和模糊字符串距离匹配，以适应轻微的拼写错误。

自定义搜索范围

要从搜索索引中排除特定页面，请在 页面 Frontmatter 中添加 noindex: true：

---
title: "内部草案规范"
noindex: true
---

离线本地语义搜索

@docmd/plugin-search 原生支持由 docmd-search 驱动的本地语义搜索。语义搜索使用客户端嵌入模型从概念上处理查询，而不是单纯匹配字面关键词。

启用语义搜索

1. 在文档工作区中安装 docmd-search：

npm install docmd-search

2. 在 docmd.config.json 中启用语义索引：

{
  "plugins": {
    "search": {
      "semantic": true
    }
  }
}

语义搜索选项

支持的嵌入模型