# @antora/pdf-extension 中文文档

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

版本：1\.0\.1
npm 元数据更新时间：2026-10-05T21:59:53.291Z
中文译文更新时间：2026-11-06T07:11:09.414Z
软件包许可：MPL-2\.0

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

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

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

- 包体积（解压后）：4.7 kB，4 个文件
- 模块格式：CommonJS
- TypeScript 类型：未声明
- Node.js 要求：\>=20\.0\.0
- 运行依赖：1 个
- 首次发布：2022-05-25T20:23:11.030Z
- 最新版本发布：2026-10-05T21:59:53.095Z
- 近 30 天下载量：26262（2026-10-06 至 2026-11-04，npm 官方下载统计）
- 已发布版本数：46（近 12 个月 21 个）

## 中文简介

Antora扩展使用Assembler将页面合并为组装文件,导出为PDF格式,并随站点发布.

## 安装

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

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

## README

# Antora PDF 扩展

Antora PDF扩展是Astora扩展和Assembler的出口国. 它配置并引用了Assembler,并提供转换器函数和元数据Assembler用于将内容导出到PDF格式. 这个扩展是将Antora站点内容导出到PDF的官方扩展.

这个扩展首先向Assembler代表,通过转换器元数据,用导航作为模型,从每个组件版本的页面中构造组装文件. Assembler然后对这些组装文件进行迭接,并使用由此扩展提供的转换器,使用 Ascidoctor PDF(或指定的命令)将其转换为PDF. 最后,Assembler将这些PDF添加到内容目录中作为出口,Antora与网站中的其他文件一起发布.

## 使用量

此套件被安装到游戏本项目后,在Antora游戏本中注册如下:

**蚂蚁游戏本. yml**

```yaml
antora:
  extensions:
  - '@antora/pdf-extension'
# ...
```

您可以使用可选配置文件配置扩展名的行为, 命名为 _角-组装器. yml_ 默认. 当使用多于一个导出扩展名时,您可能想要使用根据导出文件类型命名的专用配置文件(例如,, _角- 组装- pdf. yml_) (中文(简体) ). 配置文件可以使用 `config_file` 键.

## 版权和许可证

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

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

## 常见问题

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

Antora扩展使用Assembler将页面合并为组装文件,导出为PDF格式,并随站点发布\.

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

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

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

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

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

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

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

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

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

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

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

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

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

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