@docusaurus/theme-search-algolia
Advanced tools
@docusaurus/theme-search-algolia is a theme for Docusaurus that integrates Algolia DocSearch, providing a powerful and customizable search experience for your documentation site.
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
},
},
};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 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 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.
2.0.0-alpha.49 (2020-04-01)
docusaurus-theme-classic
docusaurus
docusaurus-types, docusaurus
docusaurus-theme-classic, docusaurus-theme-live-codeblock
docusaurus-plugin-content-docs, docusaurus
docusaurus-theme-classic
docusaurus-theme-live-codeblock
docusaurus-mdx-loader, docusaurus-theme-classic
docusaurus-theme-classic, docusaurus-theme-live-codeblock
docusaurus-preset-classic, docusaurus-theme-classic
docusaurus
docusaurus-preset-classic
docusaurus-mdx-loader
docusaurus-utils
docusaurus-theme-classic
docusaurus-plugin-content-blog
docusaurus-init
docusaurus
stylelint-copyright
FAQs
Algolia search component for Docusaurus.
The npm package @docusaurus/theme-search-algolia receives a total of 242,790 weekly downloads. As such, @docusaurus/theme-search-algolia popularity was classified as popular.
We found that @docusaurus/theme-search-algolia demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 4 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Socket’s threat research team has detected six malicious npm packages typosquatting popular libraries to insert SSH backdoors.
Security News
MITRE's 2024 CWE Top 25 highlights critical software vulnerabilities like XSS, SQL Injection, and CSRF, reflecting shifts due to a refined ranking methodology.
Security News
In this segment of the Risky Business podcast, Feross Aboukhadijeh and Patrick Gray discuss the challenges of tracking malware discovered in open source softare.