Research
Security News
Malicious npm Packages Inject SSH Backdoors via Typosquatted Libraries
Socket’s threat research team has detected six malicious npm packages typosquatting popular libraries to insert SSH backdoors.
@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.32 (2019-11-04)
<Redirect>
component for client side redirect. Example Usage:import React from 'react';
import {Redirect} from '@docusaurus/router';
function Home() {
return <Redirect to="/docs/test" />;
}
CodeBlock
theme component, it is recommended to update your source code to have this feature. (#1860)@theme/Tabs
component to be able to create tabs with only one item.@theme/Heading
component. If there is no id, it should not create anchor link.themeConfig.algolia
is not defined, the custom searchbar won't appear. If you've swizzled Algolia SearchBar
component before, please update your source code otherwise CSS might break. See #1909 for reference.- <Fragment>
+ <div className="navbar__search" key="search-box">
USE_SSH
env variable during deployment to be the same as in v1.docs/
or /docs/xxxx
that does not match any existing doc page should return 404 (Not found) page, not blank page. (#1903)@docusaurus/core
dependencies/ node_modules over user's node_modules. This fix a bug whereby if user has core-js@3 on its own node_modules but docusaurus depends on core-js@2, we previously encounter Module not found: core-js/modules/xxxx
(because core-js@3 doesn't have that)./docs
route even if docs folder is empty. We also improved docs plugin test coverage to 100% for stability before working on docs versioning. (#1912)/blog/post-xxx
will request for next and prev blog post metadata too aside from target post metadata. We should only request target post metadata. (#1908)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.