Skip to main content

Search

Docusaurus provides an awesome integration with the Algolia DocSearch.

The service is free for any open-source project: just make sure to read the checklist and apply to the DocSearch program.

A screenshot of the search window

Get started with the Docusaurus search guide.

Configuration​

If you project is accepted and you receive the api key from Algolia, you can configure it directly through the rise4fun configuration section. rise4fun will add additional options to Algolia to preconfigure it.

./docusaurus.config.js
const config = configure({ ... }, {
    ...
    algolia: {
        // The application ID provided by Algolia
        appId: 'YOUR_APP_ID',
        // Public API key: it is safe to commit it
        apiKey: 'YOUR_SEARCH_API_KEY',
        // index name as provided by Algolia
        indexName: 'YOUR_INDEX_NAME',
    }
})