概览

搜索选项

配置访问者如何搜索您的文档。

设置#

设置 出现位置
搜索按钮 在顶部页眉栏中
侧边栏搜索 在左侧侧边栏面板中

如何配置#

对于页眉搜索按钮: Float Widget → 设计页眉 选项卡 → 切换 搜索按钮

对于侧边栏搜索: Float Widget → 设计左侧侧边栏 选项卡 → 切换 侧边栏搜索

Which to Use?#

Both options are available, but enabling one location is usually enough.

Placement Best for
Header Most discoverable for first-time visitors
Sidebar Power users who navigate the sidebar frequently

Enabling both works fine — it's a matter of design preference. If your header is already crowded with links, sidebar search is a clean alternative.

How Search Works#

Docsbook 为您的仓库中的所有 Markdown 内容创建索引。当您的 GitHub 文档发生更改时,搜索索引将自动更新。

搜索内容包括:

  • 页面标题
  • 标题
  • 正文

代码块会被索引,但其排名低于散文内容。


帮助读者立即找到答案。 连接您的 GitHub 仓库 →