Security News
Dutch National Police Disrupt Redline and Meta Malware Operations
Dutch National Police and FBI dismantle Redline and Meta infostealer malware-as-a-service operations in Operation Magnus, seizing servers and source code.
@easyops-cn/docusaurus-search-local
Advanced tools
An offline/local search plugin for Docusaurus v2, which supports multiple languages, especially optimized for language of zh.
Originally forked from cmfcmf/docusaurus-search-local.
Then later fully rewritten with TypeScript 💪, styles polished 💅, language of Chinese supported 🇨🇳, and tests covered ✅.
https://easyops-cn.github.io/docusaurus-search-example/
npm install --save @easyops-cn/docusaurus-search-local
# or
yarn add @easyops-cn/docusaurus-search-local
Add @easyops-cn/docusaurus-search-local
into your docusaurus plugins.
// In your `docusaurus.config.js`:
module.exports = {
// ... Your other configurations.
plugins: [
// ... Your other plugins.
[
require.resolve("@easyops-cn/docusaurus-search-local"),
{
// ... Your options.
// `hashed` is recommended as long-term-cache of index file is possible.
hashed: true,
// For Docs using Chinese, The `language` is recommended to set to:
// ```
// language: ["en", "zh"],
// ```
// When applying `zh` in language, please install `nodejieba` in your project.
},
],
],
};
Notice!
When applying
"zh"
in language, please also installnodejieba
in your project, it became a peer dependency since v0.7.0.
npm install nodejieba
# or
yarn add nodejieba
Name | Type | Default | Description |
---|---|---|---|
indexDocs | boolean | true | Whether to index docs. |
indexBlog | boolean | true | Whether to index blog. |
indexPages | boolean | false | Whether to index pages. |
docsRouteBasePath | string | string[] | "/docs" | Base route path(s) of docs. Slash at beginning is not required. |
blogRouteBasePath | string | string[] | "/blog" | Base route path(s) of blog. Slash at beginning is not required. |
language | string | string[] | "en" | All lunr-languages supported languages, + zh 🔥. |
hashed | boolean | false | Whether to add a hashed query when fetching index (based on the content hash of all indexed *.md in docsDir and blogDir if applicable) |
docsDir | string | string[] | "docs" | The dir(s) of docs to get the content hash, it's relative to the dir of your project. |
blogDir | string | string[] | "blog" | Just like the docsDir but applied to blog. |
removeDefaultStopWordFilter | boolean | false | Sometimes people (E.g., us) want to keep the English stop words as indexed, since they maybe are relevant in programming docs. |
highlightSearchTermsOnTargetPage | boolean | false | Highlight search terms on target page. |
searchResultLimits | number | 8 | Limit the search results. |
searchResultContextMaxLength | number | 50 | Set the max length of characters of each search result to show. |
This plugin is shipped with polished styles just like the Algolia Search on the Docusaurus v2 website. Feel free to override these css custom properties (css variables) below.
Var | Default (light) | Default (dark) |
---|---|---|
--search-local-modal-background | #f5f6f7 | var(--ifm-background-color) |
--search-local-modal-shadow | inset 1px 1px 0 0 hsla(0, 0%, 100%, 0.5), 0 3px 8px 0 #555a64 | inset 1px 1px 0 0 #2c2e40, 0 3px 8px 0 #000309 |
--search-local-modal-width | 560px | - |
--search-local-modal-width-sm | 340px | - |
--search-local-spacing | 12px | - |
--search-local-hit-background | #fff | var(--ifm-color-emphasis-100) |
--search-local-hit-shadow | 0 1px 3px 0 #d4d9e1 | none |
--search-local-hit-color | #444950 | var(--ifm-font-color-base) |
--search-local-hit-height | 56px | - |
--search-local-highlight-color | var(--ifm-color-primary) | - |
--search-local-muted-color | #969faf | var(--ifm-color-secondary-darkest) |
--search-local-icon-stroke-width | 1.4 | - |
--search-local-hit-active-color | var(--ifm-color-white) | - |
E.g.:
:root {
--search-local-modal-width: 480px;
--search-local-highlight-color: #5468ff;
}
html[data-theme="dark"] {
--search-local-highlight-color: #d23669;
}
When building your docs project, Set the env DEBUG=search-local:*
to enable debug logs.
# In your docs project:
DEBUG=search-local:* yarn build
See contributing guide.
FAQs
An offline/local search plugin for Docusaurus v3
The npm package @easyops-cn/docusaurus-search-local receives a total of 32,300 weekly downloads. As such, @easyops-cn/docusaurus-search-local popularity was classified as popular.
We found that @easyops-cn/docusaurus-search-local demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 3 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.
Security News
Dutch National Police and FBI dismantle Redline and Meta infostealer malware-as-a-service operations in Operation Magnus, seizing servers and source code.
Research
Security News
Socket is tracking a new trend where malicious actors are now exploiting the popularity of LLM research to spread malware through seemingly useful open source packages.
Security News
Research
Noxia, a new dark web bulletproof host, offers dirt cheap servers for Python, Node.js, Go, and Rust, enabling cybercriminals to distribute malware and execute supply chain attacks.