VitePress 如何开启 algolia 搜索功能

最新推荐文章于 2025-07-31 17:13:33 发布

原创

最新推荐文章于 2025-07-31 17:13:33 发布 · 691 阅读

1 ·

CC 4.0 BY-SA版权

文章标签：

#node.js #typescript #react.js

VitePress 如何开启 algolia 搜索功能

原文地址--DapanDocs ：https://www.skillgroup.cn/framework/vitepress/algolia.html

什么是 Algolia

Algolia 是一种强大的搜索引擎，可以为你的 VitePress 网站提供搜索功能。

Algolia 注册

首先，你需要申请一个 Algolia 账号。你可以在 Algolia DocSearch 官网申请一个免费账号。

::: warning 注意事项

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

:::

注册成功后，你会收到一封邮件，里面包含了你的 Algolia API Key 和 Application ID。如下界面：

Algolia DocSearch 注册成功界面

根据邮箱提示操作后，你会看到如下界面：

Algolia DocSearch 首页界面

点击 “API Keys”, 获取你的 Algolia API Key 和 Application ID。如下界面：

Algolia DocSearch 密钥界面

Algolia 配置

// .vitepress/config.js
import {
     
      defineConfig } from "vite";

export default defineConfig({
    
    
  themeConfig: {
    
    
    search: {
    
    
      // provider: 'local', // 可以开启本地搜索
      provider: "algolia",
      options: {
    
    
        appId: