@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.0.1 (2023-11-30)

:bug: Bug Fix

• docusaurus-utils
  • #9570 fix: add v2 retrocompatible support for quoted admonitions (@slorber)
  • #9535 fix: v3 admonitions should support v2 title syntax for nested admonitions (@slorber)
• create-docusaurus, docusaurus-theme-classic, docusaurus-theme-common
  • #9567 fix(theme): upgrade prism-react-renderer, fix html script and style tag highlighting (@slorber)
• docusaurus-theme-common
  • #9531 fix(theme): docs html sidebar items should always be visible (@slorber)
• docusaurus-theme-classic
  • #9530 fix(theme): fix firefox CSS :has() support bug (@slorber)
• create-docusaurus
  • #9487 fix(create-docusaurus): fix readme docusaurus 2 ref (@slorber)

:robot: Dependencies

• docusaurus-plugin-debug
  • #9566 chore(debug-plugin): migrate to a new maintained JSON Viewer (@mcrstudio)
• create-docusaurus, docusaurus-theme-classic, docusaurus-theme-common
  • #9572 chore: upgrade prism-react-renderer to 2.3.0 to avoid older clsx (@harryzcy)
  • #9567 fix(theme): upgrade prism-react-renderer, fix html script and style tag highlighting (@slorber)
• create-docusaurus, docusaurus-plugin-pwa, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-theme-live-codeblock, docusaurus-theme-search-algolia
  • #9464 chore: Upgrade clsx to 2.0.0 (@harryzcy)
• docusaurus
  • #9547 chore(core): replace wait-on dependency with custom lighter code (@NickGerleman)
• docusaurus-plugin-pwa, docusaurus
  • #9529 chore: ugrade babel dependencies to v7.23.3 (@reece-white)

Committers: 6

• Chongyi Zheng (@harryzcy)
• MCR Studio (@mcrstudio)
• Nick Gerleman (@NickGerleman)
• Shreesh Nautiyal (@Shreesh09)
• Sébastien Lorber (@slorber)
• @reece-white