BxSites Search Providers Reference

search: true/false (in bxsites.yaml - see bx-sites-configuration) is the master on/off switch regardless of which searchProvider.provider is active.

local (default)

Fully static/client-side - the mkdocs default approach. At build time, SearchIndexer writes site/search-index.json: one entry per page with title, url, frontmatter tags, every heading's text, a plain-text body copy truncated to 400 characters, plus that page's section (its top-level ancestor's title) and breadcrumb (the ancestor-title chain) used for result display - so each entry is { title, url, headings, body, tags, section, breadcrumb }. hidden pages are left out. In the browser, assets/search.js fetches it once and builds a MiniSearch index (prefix + typo-tolerant fuzzy matching, both on by default; title weighted highest, then tags, then headings, then body). No server/database/external service.