# @antora/collector-extension 中文文档

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

版本：1\.0\.3
npm 元数据更新时间：2026-03-04T19:35:29.852Z
中文译文更新时间：2026-11-06T07:11:18.191Z
软件包许可：MPL-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40antora/collector-extension
原文对照：https://npmcn.com/package/%40antora/collector-extension/?lang=original
项目主页：https://antora.org/
源码仓库：https://gitlab.com/antora/antora-collector

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

- 包体积（解压后）：25.4 kB，3 个文件
- 模块格式：CommonJS
- TypeScript 类型：未声明
- Node.js 要求：\>=16\.0\.0
- 运行依赖：5 个
- 首次发布：2022-08-27T22:37:57.208Z
- 最新版本发布：2026-03-04T19:35:29.696Z
- 近 30 天下载量：16566（2026-10-06 至 2026-11-04，npm 官方下载统计）
- 已发布版本数：18（近 12 个月 1 个）

## 中文简介

Antora 扩展运行每个内容根指定的命令,并将指定的文件导入内容集合.

## 安装

```sh
npm install @antora/collector-extension
```

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

## README

# Antora 收集器扩展

Antora Collectioner扩展通过引用外部命令生成和(或)取回可以导入内容聚合的文件来增强Antora的内容聚合能力.

## 概览

Antora Collectioner扩展提供了基于配置的机制,为内容集贡献了额外的内容. 扩展允许您向零或更多的外部命令(例如, `./gradlew generateContent`可生成和/或检索文件. 扩展页还提供一个文件扫描器,以查找和导入其他文件(承诺、生成或下载)到内容汇总(以及内容目录). 这些文件随后成为Antora站点的可引用资源(如页面,部分,附件等).

您可以将 Collector 视为在您的游戏本中添加更多内容根, 而这些本子恰好是动态创建的( 并且是瞬间创建的) . 扩展可忽略到构建工具(Gradle,Maven,npm等)和-尽可能-操作系统.

## 安装

使用以下命令将扩展安装到您的游戏本项目 :

```console
$ npm i @antora/collector-extension
```

## 登记册

打开您的 Antora 播放本文件,并将扩展名注册为 `antora.extensions` 键. 如果此密钥尚未存在于您的游戏本中, 请先创建它 .

**蚂蚁游戏本. yml**

```yaml
antora:
  extensions:
  - '@antora/collector-extension'
```

## 配置

要配置扩展名, 您必须定义至少一个步骤, 包括清理、 运行和/ 扫描操作 `ext.collector` 键在组件描述符中.

**蚂蚁.yml**

```yaml
name: my-project
version: '1.0'
# ...
ext:
  collector:
    run: generate-files.js
    scan: build/generated-files
```

## 版权和许可证

版权(C)2022年-由OpenDevise Inc.和该项目的个人贡献者介绍.

该软件的使用按照下列规定进行: [Mozilla 公共许可版本 2.0](https://www.mozilla.org/en-US/MPL/2.0/) (MPL-2.0) (中文(简体) ).

## 常见问题

### @antora/collector-extension 是什么？

Antora 扩展运行每个内容根指定的命令,并将指定的文件导入内容集合\.

### 如何安装 @antora/collector-extension？

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

### @antora/collector-extension 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/antora\_\_collector-extension 是否存在。

### @antora/collector-extension 支持 ESM 还是 CommonJS？

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

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

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

### @antora/collector-extension 可以商用吗？

@antora/collector-extension 使用 MPL-2\.0 许可。弱 Copyleft：可以商用，也可以和闭源代码一起使用；但如果分发时修改了 MPL 授权的文件，这些文件的修改需以 MPL 开源。以上为概括，不构成法律意见，请以许可原文为准。

### @antora/collector-extension 的下载量有多少？

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

### @antora/collector-extension 还在维护吗？

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