An offline/local search plugin/theme 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 ✅.

• Live Demo
• Screen Shots
• Installation
• Usage
• Theme Options
• Custom Styles
• Trouble Shooting
• Further Reading
• Contributing

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

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

Since v0.25.0, we support docusaurus i18n system, and provided en 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.

{
  "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"
  }
}

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.

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

In case some specific errors occurred:

• Error: Cannot mix different versions of joi schemas:

  • Try using @easyops-cn/docusaurus-search-local >= v0.16.0 with Docusaurus >= v2.0.0-alpha.73
  • Try using @easyops-cn/docusaurus-search-local between v0.14.0 and v0.15.1 with Docusaurus between v2.0.0-alpha.68 and v2.0.0-alpha.72
  • Or try using @easyops-cn/docusaurus-search-local <= v0.13.1 with Docusaurus <= v2.0.0-alpha.66

• Module not found: Error: Can't resolve '@docusaurus/useRouteContext':

  • Try using @easyops-cn/docusaurus-search-local >= v0.25.0 with Docusaurus >= v2.0.0-beta.18
  • Try using @easyops-cn/docusaurus-search-local < v0.25.0 with Docusaurus < v2.0.0-beta.18

• 多语言全文搜索

See contributing guide.