Algolia Search
Integrate Algolia Search with Fumadocs
Notice
If you're using Algolia's free tier, you have to display their logo on your search dialog.
Introduction
The Algolia Integration automatically configures Algolia Search for document search.
By default, it creates a record for each paragraph in your document, it is officially recommended by Algolia.
Each record contains searchable attributes:
Attribute | Description |
---|---|
title | Page Title |
section | Heading ID (nullable) |
content | Paragraph content |
The section
field only exists in paragraphs under a heading. Headings and
paragraphs are indexed as an individual record, grouped by their page ID.
Setup
Install Dependencies
Sign up on Algolia
Sign up and obtain the required API keys for your search. Store these credentials in environment variables.
Sync Search Indexes
The sync
function will update the index settings and sync search indexes.
The indexes
variable should be provided by your content source provider. If you are using Fumadocs MDX, see Manifest.
Notably, it requires a structured
property, this can be obtained from Remark Structure, or sometimes supplied by the content source you are using.
You may make it a script and manually sync with node ./update-index.mjs
, or
integrate it with your CI/CD pipeline.
Notice that it expects the url
property of a page to be unique. In other words, you shouldn't have two pages with the same
url.
Typescript Usage
If you are running the script with TSX
or other similar Typescript executors, ensure to name it .mts
for best ESM
compatibility.
Search Client
To search documents on the client side, use the Fumadocs UI Search Dialog, or your own implementation.
In addition, the useAlgoliaSearch
hook can handle state management with SWR.
Options
Tag Filter
To configure tag filtering, add a tag
value to indexes.
For Fumadocs UI, enable Tag Filter on Search Dialog.
The tag
field is an attribute for faceting, use the filter tag:value
on search clients to filter indexes by tag.
Customise Attributes & Settings
While the default attributes might not suit your case, you can pass extra_data
to index options for adding extra fields to each record.
To customize the default index settings, set index settings, and update
documents with updateDocuments(...)
separately.
Last updated on