Search
The search plugin builds an index from Markdown content and exposes an endpoint for spotlight search.
The search plugin makes documentation searchable without turning the whole website into a client-side app. The index is built from Markdown pages when the app starts. The interface queries a server endpoint while the reader types.
Endpoint
The search endpoint is served under the internal path.
/_fibel/search?locale=en&q=configWhen Fibel runs under /docs, the endpoint is served at /docs/_fibel/search.
Indexed content
The index includes:
- Page title.
- Page description.
- Sidebar section.
- Markdown text of the page.
Search is locale-aware. An English query searches English pages. A German query searches German pages.
Spotlight interface
The default layout opens search from the header search button, /, or Mod+K. Results update without a full page reload. Arrow keys move the selection, and Enter opens the active result.
Project customization
Projects can replace the search plugin when they need another index, an external search system, or different ranking rules. As long as the layout queries the same endpoint, the interface can stay unchanged.
Markdown sources
Every page is also available as Markdown, for example /en/search.md. The Copy Markdown button copies that URL. This is useful for LLMs, support workflows, and review processes.