Overview
The search configuration enables you to add fast, reliable search capabilities to your documentation site. You can choose from several search providers depending on whether you want a lightweight client-side solution or a fully managed cloud search service.
Supported providers: fetch, static, algolia, orama-cloud, orama-cloud-legacy, flexsearch-static, mixedbread.
Note
Search features allow your users to quickly find relevant pages, headings, and text snippets using keyboard shortcuts like Ctrl + K or Cmd + K.
Setting Up Search Providers
Flexsearch
Flexsearch provides a fast, zero-dependency in-memory search engine that runs locally. It indexes your documentation content and supports internationalization (i18n) and CJK character sets.
Algolia
Algolia offers a hosted search engine. You can sync your documentation content to an Algolia index and query it directly from your search dialog using client configurations.
Orama & Orama Cloud
Orama is a flexible search engine that supports full-text search, vector search embeddings, and server-side or static exports. Orama Cloud provides managed cloud search indexes and web crawlers.
AI-Powered Search
You can also enable AI chat integration alongside standard search, allowing users to ask natural language questions backed by your documentation content using tools and language models.
Configuration Options
The following table summarizes the main search options available when setting up search clients and dialogs:
| Option | Type | Description |
|---|---|---|
api | string | The URL endpoint for fetching search results. |
delayMs | number | The debounced delay in milliseconds before performing a search. |
tag | string | string[] | Filter search results using specific tags. |
locale | string | Filter or target search results for a specific language locale. |
links | SearchLink[] | Custom fallback links to display when search queries are empty. |
allowClear | boolean | Allow users to clear tag filters in the search dialog. |
Tip
Always define your search dependency arrays (deps) correctly if you are customizing search client hooks to prevent unnecessary re-fetching or rendering issues.