在 Docusaurus v2 中使用 Algolia DocSearch搜索功能

最新推荐文章于 2024-05-23 10:07:00 发布

didilinkin

最新推荐文章于 2024-05-23 10:07:00 发布

阅读量316

点赞数 1

分类专栏： Docusaurus2 GitHub Actions 文章标签： github 前端自动化

本文链接：https://blog.csdn.net/didilinkin/article/details/130427595

版权

本文介绍了如何在Docusaurus v2网站中集成Algolia DocSearch，包括在Docsearch官网申请、配置本地Algolia、执行爬虫程序以及解决常见问题。通过这个教程，读者可以学会如何为自己的网站添加实时搜索功能。

摘要由CSDN通过智能技术生成

前言: Algolia 是什么？

Algolia 是一个搜索、推荐服务平台，可以通过简单的配置来为站点添加全文检索功能

基本原理：

通过爬虫对目标网站的内容创建 Records (记录), 在用户搜索时调用接口返回相关内容

一. 需求描述

为网站添加实时搜索, 采用 Docusaurus2 官方支持的 Algolia DocSearch

Docsearch 每周一次爬取网站 (可在网页界面上配置具体时间), 并将所有内容汇总到一个 Algolia 索引中

随后，前端页面会调用 Algolia API 来直接查询这些内容

Docusaurus 搜索功能文档

二. 准备工作

1. Docsearch 官网申请

前置条件:

准备项目域名地址 - 本案例: https://didilinkin.cn/

如没有服务器和域名也可用 GitHub Pages
项目的开源地址 - 本案例: https://github.com/didilinkin/didilinkin-website

前置条件准备完成后, 就可到 Docsearch 注册

提交后大约 2天内会收到反馈邮件, 通知注册成功

2. 获取 Application ID & API Keys

前往 Algolia 官网, 登录账户创建 Application

设置 Application 名称, 选择免费计划

最后选择响应速度快的服务后, 创建成功✅

控制台打开设置页面，点击 API keys

找到接下来本地配置需要的数据

三. 本地 Algolia Docsearch配置

.env (键值不带双引号)

APPLICATION_ID=Application ID
API_KEY=Admin API Key # 务必确认, 这是坑点 不要用 'Write API Key' 或者 'Search API Key'

docusaurus.config.js

module.exports = {
     
  // ...
  presets: [[
    // ...
    "classic",
    /** @type {import('@docusaurus/preset-classic').Options} */
    ({
     
      // 这个插件会为你的站点创建一个站点地图
      // 以便搜索引擎的爬虫能够更准确地爬取你的网站
      sitemap: {
     
        changefreq: "weekly",
        priority: 0.5,
        ignorePatterns: