Search Options
Configure how visitors search your documentation.
Settings#
| Setting | Where it appears |
|---|---|
| Search button | In the top header bar |
| Search in sidebar | In the left sidebar panel |
How to Configure#
For the header search button: Float Widget → Design → Header tab → toggle Search button.
For the sidebar search: Float Widget → Design → Left Sidebar tab → toggle Search in sidebar.
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 indexes all markdown content in your repository. The search index updates automatically when your docs change on GitHub.
Search covers:
- Page titles
- Headings
- Body text
Code blocks are indexed but lower-ranked than prose content.
Help readers find answers instantly. Connect your GitHub repo →