搜索栏 / 搜索按钮#

在窄视口上,用户可以通过点击 页眉 / 导航栏 中的放大镜图标 () 来访问搜索。在宽视口上,放大镜图标、搜索输入字段和聚焦搜索输入字段的键盘快捷键都会显示。键盘快捷键是:

  • Ctrl + K (Linux, Windows)

  • + K (macOS)

您还可以配置搜索按钮和搜索字段的某些方面,如下所述。

配置搜索字段位置#

搜索 按钮 的位置由 search-button 控制,默认情况下包含在 html_theme_options["navbar_persistent"] 中;您可以根据站点布局将其移动到其他位置,或将其移除。您还可以通过将 search-field.html 添加到某个配置变量(例如 html_sidebarshtml_theme_options["footer_start"] 等)中,在站点的某些/所有页面上添加一个始终可见的搜索字段。

例如,如果您希望搜索字段位于侧边栏中,请将其添加到侧边栏模板中,如下所示:

html_sidebars = {
    "**": ["search-field.html", "sidebar-nav-bs.html", "sidebar-ethical-ads.html"]
}

如果您希望将搜索字段放在顶部导航栏中,请使用以下配置:

html_theme_options = {
    "navbar_end": ["navbar-icon-links.html", "search-field.html"]
}

警告

如果页面同时包含搜索按钮和始终可见的搜索字段,键盘快捷键将聚焦在始终可见的字段上,而隐藏的搜索字段覆盖层将不会显示。这可能不是您想要的:*在小型屏幕(即移动设备)上,侧边栏可能会隐藏在抽屉中,如果持久搜索字段在那里,它可能会获得焦点而实际上并未显示。**强烈建议* 您使用搜索按钮及其附带的隐藏/覆盖字段,*或者*在布局中有意义的位置使用持久搜索字段。

配置搜索栏文本#

要修改人们在点击搜索栏之前的文本,请将以下配置添加到您的 conf.py 文件中:

html_theme_options = {
    "search_bar_text": "Your text here..."
}