Zum Hauptinhalt springen

Full-text search bar

Pro

A prominent search bar at the top-right of every page that searches the full text of every page on your docs site.

What it does

  • Indexes every page's title, headings, AND body text.
  • Live results as the user types.
  • Highlighted snippets showing where the match appeared.
  • Keyboard navigation through results (arrows + enter).
  • Mobile-friendly responsive layout.
  • Dark mode native.

Enabling it

Project settings → FeaturesFull-text search → toggle on.

The next publish builds the search index. After that, the search bar appears at the top of every page on your site.

What gets indexed

Your published content only — pages, headings, body text. The search bar doesn't index:

  • Unpublished editor drafts
  • Hidden pages (sidebar_class_name: "hidden")
  • Code inside <details> collapsed sections (yes, the text is there, but it's not indexed)

Reindex frequency

Every publish. The index is built as part of the build pipeline. Pages added or removed since the last publish appear in search after the next publish.

Search analytics

When the search bar is on, analytics gains a Search section with:

  • Top queries
  • Queries with zero results (you should probably write a page about these)
  • Click-through rate per query

Worth checking weekly — it's the highest-signal feedback you'll get on what's missing in your docs.

Customizing

Light customization in settings:

  • Placeholder text — defaults to "Search docs…"
  • Position — top-right of navbar (default), can be moved to the sidebar.

For deeper customization, custom CSS via Branding → Custom CSS.

Free vs Pro

Pro-only. Free plans get the keyboard search modal (Cmd+K) but not the prominent search bar.

Performance

  • Index size: typically ~50KB per 100 pages.
  • Search latency: under 50ms after the index loads.
  • Works fully offline once the page has loaded — no API call per keystroke.