# @astrojs/starlight-docsearch 中文文档

规范地址：https://npmcn.com/package/%40astrojs/starlight-docsearch/

版本：0\.8\.1
npm 元数据更新时间：2026-11-06T18:18:25.154Z
中文译文更新时间：2026-11-07T01:11:02.239Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40astrojs/starlight-docsearch
原文对照：https://npmcn.com/package/%40astrojs/starlight-docsearch/?lang=original
项目主页：https://starlight.astro.build/
源码仓库：https://github.com/withastro/starlight

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：21 kB，10 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：2 个
- peer 依赖：astro ^6\.0\.0 \|\| ^7\.0\.0，@astrojs/starlight \>=0\.38\.0
- 首次发布：2023-11-29T23:03:35.021Z
- 最新版本发布：2026-11-06T18:18:24.828Z
- 近 30 天下载量：15420（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：11（近 12 个月 3 个）

## 中文简介

Astro 星光文档主题的 Algolia DocSearch 插件

## 安装

```sh
npm install @astrojs/starlight-docsearch
```

也可以使用：`pnpm add @astrojs/starlight-docsearch`、`yarn add @astrojs/starlight-docsearch`、`bun add @astrojs/starlight-docsearch`

## README

# ![](https://github.com/withastro/starlight/assets/357379/494fcd83-42aa-4891-87e0-87402fa0b6f3) @astrojs/星光搜索

用于此选项的 Algolia DocSearch 插件 [星光](https://starlight.astro.build/) 文档主题 [天体](https://astro.build/)。 。 。 .

## 文档

见 [星光站点搜索指南](https://starlight.astro.build/guides/site-search/#algolia-docsearch) 用于如何使用此插件.

## 许可证

麻省理工学院

版权(c)2023年至今 [星光贡献者](https://github.com/withastro/starlight/graphs/contributors)

## 常见问题

### @astrojs/starlight-docsearch 是什么？

Astro 星光文档主题的 Algolia DocSearch 插件

### 如何安装 @astrojs/starlight-docsearch？

在项目目录运行 npm install @astrojs/starlight-docsearch，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：astro（^6\.0\.0 \|\| ^7\.0\.0）、@astrojs/starlight（\>=0\.38\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @astrojs/starlight-docsearch 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @astrojs/starlight-docsearch 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @astrojs/starlight-docsearch 可以商用吗？

@astrojs/starlight-docsearch 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @astrojs/starlight-docsearch 的下载量有多少？

根据 npm 官方下载统计，@astrojs/starlight-docsearch 在 2026/10/07 – 2026/11/05 这 30 天内被下载 15,420 次，日均约 514 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @astrojs/starlight-docsearch 还在维护吗？

最新版本 0\.8\.1 发布于 2026/11/07（1 天前）；至今共发布 11 个版本，其中过去 12 个月发布了 3 个；首次发布于 2023/11/30。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。