Docusaurus 局域搜索插件使用手册

本手册旨在引导您了解并熟练使用由 Easy Ops 团队维护的 Docusaurus 局域搜索插件，适用于Docusaurus v2/v3项目。我们将深入探讨其核心组件：项目目录结构、启动文件以及配置文件，帮助您高效集成这一功能，以提供离线或本地化的搜索体验。

1. 项目目录结构及介绍

Docusaurus 局域搜索插件的仓库遵循典型的Node.js项目结构，关键组件包括：

• src: 源代码存放地，包含主要的逻辑实现。
• website: 示例站点或文档演示，展示了插件如何在实际Docusaurus项目中应用。
• package.json: 项目依赖与脚本命令定义，是项目启动和构建的起点。
• README.md: 提供了安装、配置和使用的详细指导。
• themes: 若该插件被设计成主题，则此目录可能包含自定义主题相关的组件和样式。
• lib 和 dist: 编译后代码存放位置，用于生产环境部署。
• examples: 可能存在的示例使用场景，帮助理解如何在不同设置下应用。

2. 项目的启动文件介绍

启动这个插件并不直接涉及一个特定的“启动文件”，而是通过Docusaurus的配置流程来集成。关键步骤是在Docusaurus的配置文件（通常位于docusaurus.config.js）中添加此插件为主题之一。

在您的docusaurus.config.js中，你需要做类似以下的添加来启用此插件：

module.exports = {
  // ...
  themes: [
    [
      require.resolve('@easyops-cn/docusaurus-search-local'),
      {
        hashed: true,
        language: ['en', 'zh'],
        // 更多配置选项...
      },
    ],
    // ...其他可能的主题配置
  ],
  // ...
};

这里的require.resolve('@easyops-cn/docusaurus-search-local')指定了插件路径，而对象内则是插件的具体配置。

3. 项目的配置文件介绍

配置文件主要指的是插件的定制参数：

• indexDocs: 是否对文档进行索引，默认为true。
• indexBlog: 是否对博客内容进行索引，默认为true。
• indexPages: 是否对页面进行索引，默认为false。
• docsRouteBasePath 和 blogRouteBasePath: 分别指定文档和博客的基础路由路径。
• language: 支持的语言列表，特别支持中文"zh"。
• hashed: 控制是否为索引文件添加基于内容哈希的查询参数，用于长期缓存，可设为true, "filename", 或"query"。

还有许多其他高级配置项如忽略某些文件、自定义CSS选择器、高亮搜索词等功能，所有这些都旨在让搜索行为更加符合您的个性化需求。查阅插件的README.md文件，可以找到详尽的配置指南和各选项的解释。

为了确保正确集成此插件，请参考上述指导，并详细阅读官方提供的文档，以便充分利用其全部特性。