Docusaurus 本地搜索插件使用教程

项目介绍

@easyops-cn/docusaurus-search-local 是一个为 Docusaurus v2/v3 设计的离线/本地搜索插件。它支持多语言，特别优化了对中文的支持。该插件最初基于 cmfcmf/docusaurus-search-local 开发，后来完全使用 TypeScript 重写，并进行了样式优化和测试覆盖。

项目快速启动

安装

首先，通过 npm 或 yarn 安装插件：

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

配置

在 docusaurus.config.js 文件中添加插件配置：

module.exports = {
  // 其他配置
  themes: [
    // 其他主题
    [
      require.resolve("@easyops-cn/docusaurus-search-local"),
      /** @type {import("@easyops-cn/docusaurus-search-local").PluginOptions} */
      ({
        // 配置选项
        hashed: true,
        language: ["en", "zh"],
      }),
    ],
  ],
};

运行

完成配置后，运行以下命令启动 Docusaurus 项目：

npm run start
# 或者
yarn start

应用案例和最佳实践

案例一：多语言文档站点

假设你正在开发一个支持中英文的文档站点，使用 @easyops-cn/docusaurus-search-local 插件可以轻松实现本地搜索功能。通过配置 language: ["en", "zh"]，用户可以在搜索框中输入中英文关键词，插件会自动匹配并显示相关结果。

案例二：大型文档库

对于拥有大量文档的站点，可以通过设置 maxSearchResults 选项来限制搜索结果的数量，以提高搜索效率。例如：

{
  maxSearchResults: 10,
}

最佳实践

1. 多语言支持：确保在配置中指定所有支持的语言，以提供全面的搜索体验。
2. 性能优化：通过调整 maxSearchResults 和 searchResultContextMaxLength 等参数，优化搜索性能和用户体验。
3. 自定义样式：使用 CSS 变量自定义搜索框和结果的样式，以匹配站点的整体设计。

典型生态项目

Docusaurus

@easyops-cn/docusaurus-search-local 是基于 Docusaurus 构建的，Docusaurus 是一个用于构建文档站点的开源框架，支持 React 组件和 Markdown 文件。

Algolia DocSearch

Algolia DocSearch 是一个流行的文档搜索解决方案，但它是基于云服务的。@easyops-cn/docusaurus-search-local 提供了本地化的替代方案，适用于需要离线搜索或对数据隐私有较高要求的项目。

Lunr.js

Lunr.js 是一个轻量级的 JavaScript 搜索引擎库，@easyops-cn/docusaurus-search-local 内部使用了 Lunr.js 来实现文档的索引和搜索功能。

通过以上步骤和案例，你可以快速上手并优化使用 @easyops-cn/docusaurus-search-local 插件，为你的 Docusaurus 文档站点提供强大的本地搜索功能。