启用全文搜索
Docsbook 会为仓库中的每个 Markdown 页面建立索引,并可在两个位置显示该索引:页眉中的搜索按钮,以及左侧边栏中的搜索框。读者搜索不会消耗项目余额——它查询的是 Docsbook 已经建立的索引。
开启页眉搜索按钮#
- 登录后打开您的文档网站。
- 打开 Float Widget → 设计 → 页眉选项卡。
- 开启搜索按钮。
- 点击保存。
该按钮会显示在每个页面的顶部栏中。
开启侧边栏搜索#
- 登录后打开您的文档网站。
- 打开 Float Widget → 设计 → 左侧边栏选项卡。
- 开启在侧边栏中搜索。
- 点击保存。
该框会显示在左侧面板的导航树上方。
选择搜索框的位置#
两种放置方式可以同时运行。通常启用其中一种就足够了。
| 位置 | 最适合 | 权衡 |
|---|---|---|
| 页眉 | 首次访问的访客,他们通常会先查看顶部栏 | 会与页眉链接争夺空间 |
| 侧边栏 | 已经通过树形结构进行导航的读者 | 在侧边栏折叠的窄屏上会被隐藏 |
如果你的页眉已经包含多个链接,请使用侧边栏搜索,而不是向顶部栏添加另一个控件。
Docsbook 搜索索引的内容#
Docsbook 全文搜索涵盖网站发布的每个 Markdown 文件,并会在您的 GitHub 仓库发生更改时重建索引。无需手动重新建立索引。
搜索匹配以下内容:
- 页面标题
- 标题
- 正文
- 代码块,排名低于普通文本
关键词搜索针对该索引执行,且从不调用 AI 模型,因此不会消耗您的项目余额。语义搜索——即按含义而非关键词进行匹配——会调用模型,并像其他 AI 使用一样从余额中扣费。