如何给 VitePress 的静态网站添加 algolia 搜索

给 VitePress 添加 algolia 搜索

前期准备

账号与创建应用

需要再 algolia 官网 注册一个账号，或者直接选择以 GitHub 身份登录。

登录之后会进入控制台页面，点击右上角头像，会有一个设置选项，之后来到 Applications 这里，去创建一个应用，以我自己的为例。

配置

获取 key

如图下所示，进入 API Keys 页面。会看到如下界面，一个是可公开的，Search-Only API Key 是待会我们在 VitePress 项目中会使用的，而 Admin API Key 是用于一会爬虫的 key，因为是私有的，所以一会放在 Github Secrets 中。

在文档中填写 key

在上一步我们获取了公开的 key，在这里我们就来配置一下，将上述的 Search-Only API Key 填到 apiKey 字段中，私有的 key 不要填！

修改文件在 docs/.vitepress/config 文件中，具体可参考链接 config.ts。

{
   
   
  "xxx": {
   
   
    // ...
  },
  "algolia": {
   
   
    "appId": "xxx", // 需要替换 Application ID