Home

Awesome

@easyops-cn/docusaurus-search-local

Npm Version CI Status Coverage Status

An offline/local search plugin/theme for Docusaurus v2/v3, 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 โœ….

Live Demo

https://easyops-cn.github.io/docusaurus-search-local/

Screen Shots

Screen Shot EN

Screen Shot ZH

Installation

npm install --save @easyops-cn/docusaurus-search-local
# or
yarn add @easyops-cn/docusaurus-search-local

Usage

Add @easyops-cn/docusaurus-search-local into your docusaurus themes.

// In your `docusaurus.config.js`:
module.exports = {
  // ... Your other configurations.
  themes: [
    // ... Your other themes.
    [
      require.resolve("@easyops-cn/docusaurus-search-local"),
      /** @type {import("@easyops-cn/docusaurus-search-local").PluginOptions} */
      ({
        // ... 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"],
        // ```
      }),
    ],
  ],
};

Notice: We present this as a theme instead of plugin now, see this comment.

Theme Options

NameTypeDefaultDescription
indexDocsbooleantrueWhether to index docs.
indexBlogbooleantrueWhether to index blog.
indexPagesbooleanfalseWhether to index pages.
docsRouteBasePathstring | string[]"/docs"Base route path(s) of docs. Slash at beginning is not required. Note: for docs-only mode, this needs to be the same as routeBasePath in your @docusaurus/preset-classic config e.g., "/".
blogRouteBasePathstring | string[]"/blog"Base route path(s) of blog. Slash at beginning is not required.
languagestring | string[]"en"All lunr-languages supported languages, + zh ๐Ÿ”ฅ.
hashedboolean | "filename" | "query"falseWhether to add a hashed query when fetching index (based on the content hash of all indexed *.md in docsDir and blogDir if applicable). Setting to "filename" will save hash in filename instead of query.
docsDirstring | string[]"docs"The dir(s) of docs to get the content hash, it's relative to the dir of your project.
blogDirstring | string[]"blog"Just like the docsDir but applied to blog.
removeDefaultStopWordFilterbooleanfalseSometimes people (E.g., us) want to keep the English stop words as indexed, since they maybe are relevant in programming docs.
removeDefaultStemmerbooleanfalseEnable this if you want to be able to search for any partial word at the cost of search performance.
highlightSearchTermsOnTargetPagebooleanfalseHighlight search terms on target page.
searchResultLimitsnumber8Limit the search results.
searchResultContextMaxLengthnumber50Set the max length of characters of each search result to show.
explicitSearchResultPathbooleanfalseWhether an explicit path to a heading should be presented on a suggestion template.
ignoreFilesstring | RegExp | (string | RegExp)[][]Set the match rules to ignore some routes. Put a string if you want an exact match, or put a regex if you want a partial match. Note: without the website base url.
ignoreCssSelectorsstring | string[][]A list of css selectors to ignore when indexing each page.
searchBarShortcutbooleantrueWhether to enable keyboard shortcut to focus in search bar.
searchBarShortcutHintbooleantrueWhether to show keyboard shortcut hint in search bar. Disable it if you need to hide the hint while shortcut is still enabled.
searchBarPosition"auto" | "left" | "right""auto"The side of the navbar the search bar should appear on. By default, it will try to autodetect based on your docusaurus config according to the docs.
docsPluginIdForPreferredVersionstringWhen you're using multi-instance of docs, set the docs plugin id which you'd like to check the preferred version with, for the search index.
zhUserDictstringProvide your custom dict for language of zh, see here
zhUserDictPathstringProvide the file path to your custom dict for language of zh, E.g.: path.resolve("./src/zh-dict.txt")
searchContextByPaths(string | { label: string | Record<string, string>; path: string; } )[][]Provide an list of sub-paths as separate search context, E.g.: ["docs", "community", "legacy/resources"]. It will create multiple search indexes by these paths.
hideSearchBarWithNoSearchContextbooleanfalseWhether to hide the search bar when no search context was matched. By default, if searchContextByPaths is set, pages which are not matched with it will be considered as with a search context of ROOT. By setting hideSearchBarWithNoSearchContext: true, these pages will be considered as with NO search context, and the search bar will be hidden.
useAllContextsWithNoSearchContextbooleanfalseWhether to show results from all the contexts if no context is provided. This option should not be used with hideSearchBarWithNoSearchContext: true as this would show results when there is no search context. This will duplicate indexes and might have a performance cost depending on the index sizes.
forceIgnoreNoIndexbooleanfalseForce enable search index even if noIndex: true is set, this also affects unlisted articles.

I18N

Since v0.25.0, we support docusaurus i18n system, and provided en / de / vi and zh-CN translations out of the box.

For other languages, please follow the official tutorial about how to translate plugin data. And translate theme.SearchBar.* and theme.SearchPage.* in i18n/*/code.json.

Translations by options is dropped since v0.25.0.

<details> <summary>See translation options for &lt;0.25.0</summary> To make this theme localized, pass a `translations` option which defaults to: 
{
  "translations": {
    "search_placeholder": "Search",
    "see_all_results": "See all results",
    "no_results": "No results.",
    "search_results_for": "Search results for \"{{ keyword }}\"",
    "search_the_documentation": "Search the documentation",
    "count_documents_found": "{{ count }} document found",
    "count_documents_found_plural": "{{ count }} documents found",
    "no_documents_were_found": "No documents were found"
  }
}

Note that *_plural can be omitted if it is the same as singular.

</details>

Custom Styles

This theme 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.

VarDefault (light)Default (dark)
--search-local-modal-background#f5f6f7var(--ifm-background-color)
--search-local-modal-shadowinset 1px 1px 0 0 hsla(0, 0%, 100%, 0.5),<br />0 3px 8px 0 #555a64inset 1px 1px 0 0 #2c2e40,<br />0 3px 8px 0 #000309
--search-local-modal-width560px-
--search-local-modal-width-sm340px-
--search-local-spacing12px-
--search-local-hit-background#fffvar(--ifm-color-emphasis-100)
--search-local-hit-shadow0 1px 3px 0 #d4d9e1none
--search-local-hit-color#444950var(--ifm-font-color-base)
--search-local-hit-height56px-
--search-local-highlight-colorvar(--ifm-color-primary)-
--search-local-muted-color#969fafvar(--ifm-color-secondary-darkest)
--search-local-icon-stroke-width1.4-
--search-local-hit-active-colorvar(--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;
}

Trouble Shooting

When building your docs project, Set the env DEBUG=search-local:* to enable debug logs.

# In your docs project:
DEBUG=search-local:* yarn build

In case some specific errors occurred:

Further Reading

Contributing

See contributing guide.