给 `vitepress` 配置 `algolia` 指南

背景

最近折腾 VitePress,想给自己的博客添加一个algolia搜索,

发现网上很多文章,还是基于老版本的vitepress使用github-Actions的CI自动爬取数据来实时更新

目前最新版本 VitePress 支持使用 Algolia DocSearch 搜索您的文档站点

避免大家被误导,所以写这个文章,避免踩坑

使用 Algolia

1. 申请使用Algolia DocSearch

docsearch 申请地址

这里有几点需要注意:

  • 您必须是该网站的所有者,或至少有更新其内容的权限
  • 你的网站必须是公开的
  • 你的网站必须是一个开源项目或技术博客的技术文档,不授权于商业内容
  • 你的网站必须到生产环境

申请成功后,Algolia官方会给你填写的邮箱发送邮件,提醒你接受邀请,申请成功的邮件如下:

点击该地址会让你注册账号登录Algolia,或者第三方选项登录,我个人是以 GitHub 身份登录


成功登录会进入控制台页面,之后来到 Applications 这里,去创建一个应用,以我自己的为例,下图已经创建好了「vitepress」。

如果是点击邮件里的邀请地址,Algolia会默认创建好一个应用,如果没有,自己单独创建一个即可。


2. 配置

VitePress 支持使用 Algolia DocSearch 搜索您的文档站点,只需要在 .vitepress/config.js,配置Algolia参数即可

2.1 获取应用的key

如图下所示,进入 API Keys 页面。

进入该页面后,你会看见 Application IDSearch API Key,这个2个参数就是我们需要在.vitepress/config.js配置文件的参数

indexName参数可以在邮件查看,也可以在控制台搜索里查看


2.2 VitePress配置Algolia

js 复制代码
import { defineConfig } from 'vitepress'

export default defineConfig({
  themeConfig: {
    search: {
      provider: 'algolia',
      options: {
        appId: '...', // 你的 Application ID
        apiKey: '...', // 你的Search API Key
        indexName: 'chunge16vitepress' // 你的indexName
      }
    }
  }
})

更多的配置可以查看 docsearch API Reference


结尾

其实vitepress 官方的本地搜索,已经很不错了,但algolia搜索更全面和强大一些。

参考

相关推荐
群联云防护小杜3 分钟前
深度隐匿源IP:高防+群联AI云防护防绕过实战
运维·服务器·前端·网络·人工智能·网络协议·tcp/ip
汉得数字平台21 分钟前
【鲲苍提效】全面洞察用户体验,助力打造高性能前端应用
前端·前端监控
花海如潮淹27 分钟前
前端性能追踪工具:用户体验的毫秒战争
前端·笔记·ux
_丿丨丨_5 小时前
XSS(跨站脚本攻击)
前端·网络·xss
天天进步20155 小时前
前端安全指南:防御XSS与CSRF攻击
前端·安全·xss
拾光拾趣录8 小时前
括号生成算法
前端·算法
拾光拾趣录9 小时前
requestIdleCallback:让你的网页如丝般顺滑
前端·性能优化
前端 贾公子9 小时前
vue-cli 模式下安装 uni-ui
前端·javascript·windows
拾光拾趣录9 小时前
链表合并:双指针与递归
前端·javascript·算法
@大迁世界9 小时前
前端:优秀架构的坟墓
前端·架构