如何在Docusaurus项目中接入Algolia DocSearch？求步骤指引

核心逻辑先明确 #

不用手动把完整数据发给Algolia，Docusaurus官方插件已经搞定了自动同步的事儿，你只需要完成配置和爬虫设置就行，下面是具体步骤：

1. 确认依赖是否齐全 #

如果你的项目用的是官方经典预设，相关插件应该已经安装完成；要是没装，先执行这个命令：

npm install @docusaurus/plugin-content-docs @docusaurus/preset-classic --save

2. 修改 docusaurus.config.js 配置 #

打开项目根目录的docusaurus.config.js，找到themeConfig节点，添加Algolia相关配置，把你拿到的API ID、API Key填进去，注意要先在Algolia后台创建好索引，把索引名称也对应填上：

module.exports = {
  // ...其他已有的配置内容
  themeConfig: {
    // ...其他主题配置
    algolia: {
      appId: '你的API ID',
      apiKey: '你的API Key', // 注意使用搜索专用Key，别用权限过高的Admin Key
      indexName: '你在Algolia后台创建的索引名称',
      contextualSearch: true, // 开启后搜索结果会附带上下文，体验更好
      // searchParameters: {}, // 可选，可自定义排序、过滤等搜索参数
    },
  },
};

3. 配置 Algolia 爬虫（关键步骤） #

Algolia是通过爬虫抓取你的文档内容生成索引的，操作步骤如下：

• 登录Algolia后台，先进入Indices页面新建一个索引，名称要和上面配置里的indexName完全一致
• 切换到Crawlers页面，创建新爬虫，将你的Docusaurus网站域名设置为爬取源
• 配置爬取规则：
  • 限定只爬取文档相关路径，比如/docs/**，避免爬取首页、404等无关页面
  • 设置爬取频率，比如每天自动爬取一次，保证文档更新后索引同步
• 手动触发一次爬取，等待爬虫执行完成，索引就会生成

4. 测试与部署 #

• 本地执行npm run start启动项目，测试搜索框是否能正常调用Algolia接口返回结果
• 部署到线上后，确保Algolia爬虫能正常访问你的站点；如果站点是私有或需要权限，要在爬虫配置中添加对应的访问凭证

常见疑问解答 #

• 是否需要手动发送数据？：完全不需要，爬虫自动抓取更省心，还能跟随文档更新自动同步索引
• 索引配置有哪些注意点？：在Algolia后台的索引页面，可调整内容权重、分词规则、同义词等，优化搜索结果的准确性
• API Key选择要注意什么？：务必使用搜索专用Key，Admin Key权限过大，泄露后会带来安全风险

内容的提问来源于stack exchange，提问作者Akash Gupta