@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

The README file is missing

Changelog

2.0.0-alpha.50 (2020-04-02)

HOTFIX for 2.0.0-alpha.49.

:bug: Bug Fix

• docusaurus-theme-classic, docusaurus-theme-live-codeblock
  • #2509 fix(v2): synchronize code block components changes (@lex111)
• docusaurus-theme-classic
  • #2498 fix(v2): blog item styling (@yangshun)
  • #2489 fix(v2): fix HTML issues nav dropdown and highlight docs item (@lex111)
• docusaurus
  • #2496 fix(v2): do not force terminate building when running deploy command (@lex111)
• docusaurus-utils
  • #2497 fix(v2): unbreak blog-only mode routing by deplicating starting forward slashes (@SamChou19815)

:nail_care: Polish

• docusaurus-theme-classic
  • #2505 fix(v2): tweak colors for announcement bar (@yangshun)
  • #2504 refactor(v2): improve announcement bar (@lex111)
  • #2495 refactor(v2): update HTML markup of pagination for better a11y (@lex111)
• docusaurus-theme-classic, docusaurus-theme-live-codeblock
  • #2502 fix(v2): make code block nicer (@yangshun)
• docusaurus-plugin-content-docs, docusaurus
  • #2490 fix(v2): use lodash instead of array-map-polyfill (@lex111)

:memo: Documentation

• docusaurus-theme-classic
  • #2500 docs(v2): misc docs updates (@yangshun)

:house: Internal

• #2486 misc: add instructions about test release (@lex111)

Committers: 5

• Alexey Pyltsyn (@lex111)
• Can Gencer (@cangencer)
• Richard Chan (@iWun)
• Sam Zhou (@SamChou19815)
• Yangshun Tay (@yangshun)