搜索栏/搜索按钮#

在窄视窗中,用户可以通过点击 头部/导航栏 中的放大镜图标 () 来访问搜索。在宽视窗中,放大镜图标、搜索输入框和聚焦搜索输入框的键盘快捷键都会显示。键盘快捷键为:

  • 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..."
}