给 `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搜索更全面和强大一些。

参考

相关推荐
Cacciatore->4 分钟前
React 基本介绍与项目创建
前端·react.js·arcgis
摸鱼仙人~5 分钟前
React Ref 指南:原理、实现与实践
前端·javascript·react.js
teeeeeeemo7 分钟前
回调函数 vs Promise vs async/await区别
开发语言·前端·javascript·笔记
贵沫末25 分钟前
React——基础
前端·react.js·前端框架
aklry37 分钟前
uniapp三步完成一维码的生成
前端·vue.js
Rubin9344 分钟前
判断元素在可视区域?用于滚动加载,数据埋点等
前端
爱学习的茄子44 分钟前
AI驱动的单词学习应用:从图片识别到语音合成的完整实现
前端·深度学习·react.js
用户3802258598241 小时前
使用three.js实现3D地球
前端·three.js
程序无bug1 小时前
Spring 面向切面编程AOP 详细讲解
java·前端
zhanshuo1 小时前
鸿蒙UI开发全解:JS与Java双引擎实战指南
前端·javascript·harmonyos