Docusaurus 本地搜索插件使用指南

1. 项目的目录结构及介绍

docusaurus-search-local/
├── src/
│   ├── client/
│   └── server/
├── static/
├── docusaurus.config.js
├── package.json
├── README.md
└── ...

• src/: 包含客户端和服务器端的源代码。
  • client/: 客户端代码，负责前端搜索功能的实现。
  • server/: 服务器端代码，负责索引和提供搜索服务。
• static/: 静态文件目录，用于存放静态资源。
• docusaurus.config.js: Docusaurus 配置文件。
• package.json: 项目依赖和脚本配置文件。
• README.md: 项目说明文档。

2. 项目的启动文件介绍

项目的启动文件主要集中在 src/ 目录下。以下是关键文件的介绍：

• src/client/index.js: 客户端入口文件，负责初始化和配置前端搜索功能。
• src/server/index.js: 服务器端入口文件，负责启动搜索服务和索引文档。

3. 项目的配置文件介绍

• docusaurus.config.js: 这是 Docusaurus 的主要配置文件，包含网站的元数据、插件配置、主题配置等。

module.exports = {
  title: 'My Site',
  tagline: 'The tagline of my site',
  url: 'https://your-docusaurus-test-site.com',
  baseUrl: '/',
  onBrokenLinks: 'throw',
  onBrokenMarkdownLinks: 'warn',
  favicon: 'img/favicon.ico',
  organizationName: 'facebook', // Usually your GitHub org/user name.
  projectName: 'docusaurus', // Usually your repo name.
  plugins: [
    [
      require.resolve('@cmfcmf/docusaurus-search-local'),
      {
        // 配置选项
      },
    ],
  ],
  // 其他配置...
};

在 plugins 部分，你可以配置 @cmfcmf/docusaurus-search-local 插件的选项，例如索引路径、语言等。

通过以上配置，你可以轻松地在 Docusaurus 项目中集成本地搜索功能。