# @diplodoc/search-extension 中文文档

规范地址：https://npmcn.com/package/%40diplodoc/search-extension/

版本：3\.1\.5
npm 元数据更新时间：2026-10-28T15:29:26.929Z
中文译文更新时间：2026-11-13T05:26:52.048Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40diplodoc/search-extension
原文对照：https://npmcn.com/package/%40diplodoc/search-extension/?lang=original
项目主页：https://github.com/diplodoc-platform/search-extension#readme
源码仓库：https://github.com/diplodoc-platform/search-extension

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

- 包体积（解压后）：7.8 MB，145 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=24
- 运行依赖：4 个
- 首次发布：2024-09-24T19:18:46.840Z
- 最新版本发布：2026-10-28T15:29:26.349Z
- 近 30 天下载量：2198（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：26（近 12 个月 11 个）

## 中文简介

Diplodoc 平台基于 Lunr 的离线搜索扩展

## 安装

```sh
npm install @diplodoc/search-extension
```

也可以使用：`pnpm add @diplodoc/search-extension`、`yarn add @diplodoc/search-extension`、`bun add @diplodoc/search-extension`

## README

**英语** | [русский](https://github.com/diplodoc-platform/search-extension/blob/master/README.ru.md)

* * *

[![NPM version](https://img.shields.io/npm/v/@diplodoc/search-extension.svg?style=flat)](https://www.npmjs.org/package/@diplodoc/search-extension) [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=diplodoc-platform_search-extension&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=diplodoc-platform_search-extension) [![Coverage](https://sonarcloud.io/api/project_badges/measure?project=diplodoc-platform_search-extension&metric=coverage)](https://sonarcloud.io/summary/new_code?id=diplodoc-platform_search-extension) [![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=diplodoc-platform_search-extension&metric=sqale_rating)](https://sonarcloud.io/summary/new_code?id=diplodoc-platform_search-extension) [![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=diplodoc-platform_search-extension&metric=reliability_rating)](https://sonarcloud.io/summary/new_code?id=diplodoc-platform_search-extension) [![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=diplodoc-platform_search-extension&metric=security_rating)](https://sonarcloud.io/summary/new_code?id=diplodoc-platform_search-extension)

# Diplodoc 搜索扩展名

这是Diplodoc平台的扩展,增加了离线搜索功能. 用这个 [润滑剂](https://lunrjs.com/) 搜索

扩展部分包括:

-   [索引器](https://npmcn.com/package/%40diplodoc/search-extension/#readme-indexer)
-   [工人](https://npmcn.com/package/%40diplodoc/search-extension/#readme-worker)

## 索引器 \\\\ \\ \\ \\

从文档中提取文本信息. 编制搜索索引和搜索文件登记册.

实例方法 :

**添加** - 在搜索索引中添加新条目

**释放** - 目标语言的倾倒指数和登记.

## 工人们

实施客户端搜索工界面. 在索引器 lunr 索引中编写的用于解决搜索请求的用途 .

扩展搜索分数算法 :

-   添加数 `tolerance` 行为. `tolerance=0` - 只寻求严格的平等词 `tolerance=1` - 还要寻找尾巴不明的词. `word*` `tolerance=2` - 还要寻找没有说明的尾巴和头部的词. `*word*`
    
-   添加数 `confidence` 行为. `phrased` - 默认。 此外,还按找到的短语长度计分结果 `sparsed` - 使用默认的lunr分数算法.
    

## 文档

-   **对 AI 代理和开发者** 看到了吗 [一般事务人员(其他职等)](https://npmcn.com/package/%40diplodoc/search-extension/AGENTS.md) 用于设置、脚本和投稿笔记.

## 常见问题

### @diplodoc/search-extension 是什么？

Diplodoc 平台基于 Lunr 的离线搜索扩展

### 如何安装 @diplodoc/search-extension？

在项目目录运行 npm install @diplodoc/search-extension，或使用 pnpm add / yarn add / bun add。

### @diplodoc/search-extension 支持 TypeScript 吗？

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

### @diplodoc/search-extension 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @diplodoc/search-extension 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=24。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @diplodoc/search-extension 可以商用吗？

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

### @diplodoc/search-extension 的下载量有多少？

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

### @diplodoc/search-extension 还在维护吗？

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