OpenManual
进阶

搜索配置

学习如何配置和使用 OpenManual 的内置全文搜索功能。

搜索配置

OpenManual 内置全文搜索功能,默认开启。

搜索位置配置

搜索功能默认开启,无需额外配置。如需调整搜索入口位置:

{
  "search": {
    "position": "header"
  }
}
字段类型默认值说明
search.positionstring'sidebar'搜索入口位置:'sidebar'(侧边栏顶部)或 'header'(导航栏中间)

搜索行为

搜索功能会自动索引所有在 sidebar 中注册的页面内容,包括:

  • 页面标题
  • 页面正文内容
  • 代码块中的文本

用户可以通过搜索框快速定位到相关内容。

优化搜索效果

以下是一些优化搜索效果的建议:

  • 为每个页面设置清晰的 title
  • 使用描述性的标题层级(h1-h6)
  • 在重要概念周围使用适当的上下文文本
  • 避免在代码块中放置大量无关内容

On this page