Implement document search in your docs
Fumadocs UI provides a good-looking search UI for your docs, the search functionality is instead provided and documented on Fumadocs Core.
See Document Search.
Open with ⌘ K or Ctrl K.
You can customize search UI from the Root Provider component in root layout.
When not specified, it uses the Default fetch Search Client powered by Orama.
Add custom link items to search dialog. They are shown as fallbacks when the query is empty.
import { RootProvider }
To opt-out of document search, disable it from root provider.
import { RootProvider }
Customise the hot keys to trigger search dialog.
import { RootProvider }
Add UI to change filters. Make sure to configure Tag Filter on search server first.
import { RootProvider }
Pass options to the search client, like changing the API endpoint for Orama search server:
import { RootProvider }
You can replace the default Search Dialog with:
'use client'
To pass it to the Root Provider, you need a wrapper with use client directive.
'use client';
Use it instead of your previous Root Provider
import { Provider }
For the setup guide, see Integrate Algolia Search.
While generally we recommend building your own search with their client-side SDK, you can also plug the built-in dialog interface.
'use client'
Replace appId, apiKey and indexName with your desired values.
Replace the default search dialog with your new component.
Note
The built-in implementation doesn't use instant search (their official javascript client).
Same as default search client, you can configure Tag Filter on the dialog.
import SearchDialog
For the setup guide, see Integrate Orama Cloud.
'use client'
endpoint, apiKey with your desired values.A list of integrations maintained by community.
If you want to use the built-in search dialog UI instead of building your own,
you may use the SearchDialog component.
import {
Unstable
It is an internal API, might break during iterations
Join the community
Subscribe to our newsletter for the latest news and updates
