让开源，少一点语言距离。
npm包中文文档

@diplodoc/search-extension

中文文档
3.1.5发布于 2026/10/28MITTypeScriptCommonJS构建来源已验证近 30 天下载 2198

Lunr based offline search extension for Diplodoc platform

原始使用文档
中文原文
文档目录3 节
  1. Indexer {#indexer}
  2. Worker {#worker}
  3. Documentation

english | русский

NPM version Quality Gate Status Coverage Maintainability Rating Reliability Rating Security Rating

Diplodoc search extension

This is an extension of the Diplodoc platform, which adds offline search functionality. It uses lunr search

The extension contains some parts:

Indexer {#indexer}

Extracts text information from documents. Prepares search index and search documents registry.

Instance methods:

add - Adds new entry to search index

release - Dumps index and registry for target language.

Worker {#worker}

Implements client search worker interface. Uses prepared in indexer lunr index to resolve search requests.

Extends search score algorithm:

  • Adds tolerance behavior. tolerance=0 - only search for strict equal words tolerance=1 - also search for words with unspecified tail. word* tolerance=2 - also search for words with unspecified tail and head. *word*

  • Adds confidence behavior. phrased - default. Additionally scores results by found phrase length sparsed - Uses default lunr scoring algorithm.

Documentation

  • For AI agents and developers — see AGENTS.md for setup, scripts, and contribution notes.

版本与发布记录

@diplodoc/search-extension 共发布 26 个版本，首次发布于 2024/09/25；过去 12 个月发布了 11 个版本。最新版本附带 npm provenance 构建来源证明，可追溯到公开的 CI 构建记录。

版本发布日期距今
3.1.5latest2026/10/2815 天前
3.1.42026/09/221 个月前
3.1.32026/09/141 个月前
3.1.22026/09/102 个月前
3.1.12026/08/133 个月前
3.1.02026/08/073 个月前

关于 @diplodoc/search-extension 的常见问题

@diplodoc/search-extension 是什么？

Lunr based offline search extension for Diplodoc platform

如何安装 @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 和提交记录判断。