@easyops-cn/docusaurus-search-local

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
• Screen Shots
• Installation
• Usage
• Theme Options
• Custom Styles
• Trouble Shooting
• Further Reading
• Contributing

Live Demo

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

Screen Shots

✨ Ask AI Support

This plugin now supports Ask AI integration! Enable AI-powered assistance directly in your documentation site to help users get instant, context-aware answers.

NOTE: Ask AI feature requires an external AI service. Please refer to the Open Ask AI Server, which is a serverless solution, and can be used for free using Vercel Hobby Plan!

Installing Ask AI

The Ask AI feature is opt-in. To enable it, you need to install the open-ask-ai package separately:

npm install --save open-ask-ai
# or
yarn add open-ask-ai

With Ask AI enabled, users can:

• Get intelligent answers based on your documentation
• Access AI assistance with a simple keyboard shortcut
• Receive context-aware responses tailored to your content

See the askAi option in Theme Options below for configuration details.

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, it is recomended to set:
        // language: ["en", "zh"],

        // Customize the keyboard shortcut to focus search bar (default is "mod+k"):
        // searchBarShortcutKeymap: "s", // Use 'S' key
        // searchBarShortcutKeymap: "ctrl+shift+f", // Use Ctrl+Shift+F

        // If you're using `noIndex: true`, set `forceIgnoreNoIndex` to enable local index:
        // forceIgnoreNoIndex: true,

        // Enable Ask AI integration:
        // askAi: {
        //   project: "your-project-name",
        //   apiUrl: "https://your-api-url.com/api/stream",
        //   hotkey: "cmd+I", // Optional: keyboard shortcut to trigger Ask AI
        // },
      }),
    ],
  ],
};

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

Theme Options