@docusaurus/theme-search-algolia

What is @docusaurus/theme-search-algolia?

@docusaurus/theme-search-algolia is a theme for Docusaurus that integrates Algolia DocSearch, providing a powerful and customizable search experience for your documentation site.

What are @docusaurus/theme-search-algolia's main functionalities?

Integration with Algolia DocSearch

This feature allows you to integrate Algolia DocSearch into your Docusaurus site by providing your Algolia API key, index name, and optionally, your Algolia App ID.

module.exports = {
  themeConfig: {
    algolia: {
      apiKey: 'YOUR_API_KEY',
      indexName: 'YOUR_INDEX_NAME',
      appId: 'YOUR_APP_ID', // Optional, if you have an Algolia App ID
    },
  },
};

Customizable Search UI

This feature allows you to customize the search UI by enabling contextual search and adding additional search parameters.

module.exports = {
  themeConfig: {
    algolia: {
      apiKey: 'YOUR_API_KEY',
      indexName: 'YOUR_INDEX_NAME',
      contextualSearch: true, // Optional, enables contextual search
      searchParameters: {}, // Optional, additional search parameters
    },
  },
};

Styling and Theming

This feature allows you to style and theme the search component by including external stylesheets and configuring the search page path.

module.exports = {
  stylesheets: [
    'https://cdn.jsdelivr.net/npm/@algolia/autocomplete-theme-classic',
  ],
  themeConfig: {
    algolia: {
      apiKey: 'YOUR_API_KEY',
      indexName: 'YOUR_INDEX_NAME',
      searchPagePath: 'search', // Optional, custom search page path
    },
  },
};

Other packages similar to @docusaurus/theme-search-algolia

react-instantsearch-dom

react-instantsearch-dom is a library for building search interfaces with Algolia in React applications. It provides a set of React components and connectors to build powerful search experiences. Compared to @docusaurus/theme-search-algolia, it offers more flexibility and customization options but requires more setup and configuration.

docsearch.js

docsearch.js is a JavaScript library that provides a ready-to-use search experience for documentation websites using Algolia DocSearch. It is less integrated with Docusaurus compared to @docusaurus/theme-search-algolia but can be used with any static site generator or custom website.

gatsby-plugin-algolia

gatsby-plugin-algolia is a Gatsby plugin that integrates Algolia search into Gatsby sites. It provides a way to index your Gatsby site's content and build a search interface using Algolia. It is similar to @docusaurus/theme-search-algolia but tailored for Gatsby sites.

README

@docusaurus/theme-search-algolia

Algolia search component for Docusaurus.

Usage

See @docusaurus/theme-search-algolia documentation.

Changelog

3.8.1 (2025-06-06)

:bug: Bug Fix

• docusaurus-theme-classic
  • #11242 fix(theme): fix unability to navigate to category's page when browsing its children items (@slorber)
• docusaurus-plugin-css-cascade-layers
  • #11241 fix(css-cascade-layers): fix windows css cascade layers bug (@slorber)
• docusaurus
  • #11222 fix(bundler): fix docusaurus start using concatenateModules: true (@slorber)
  • #11217 fix: include Arc to supported Chromium Browsers (@wellwelwel)
  • #11205 fix(core): fix docusaurus start error for macOS users with no Chromium-based browser (@slorber)
• docusaurus-types
  • #11221 fix(types): fix future flags public types (@slorber)

:running_woman: Performance

• docusaurus-plugin-content-blog, docusaurus-plugin-sitemap, docusaurus-theme-classic, docusaurus-types, docusaurus-utils, docusaurus
  • #11211 perf: avoid duplicated git log calls in loadContent() and postBuild() for untracked Git files (@slorber)

:wrench: Maintenance

• docusaurus-faster
  • #11248 chore(faster): upgrade Rspack (@slorber)
• docusaurus-plugin-content-docs
  • #11230 refactor(docs): extract loadVersion() without changing the behavior (@slorber)
• Other
  • #11212 chore: upgrade to Node 22 by default (@slorber)

Committers: 7

• Ben McCann (@benmccann)
• Dave Meyer (@dave-meyer)
• Léo Vincent (@leovct)
• Noritaka Kobayashi (@noritaka1166)
• Phil Parsons (@p-m-p)
• Sébastien Lorber (@slorber)
• Weslley Araújo (@wellwelwel)