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

@antora/pdf-extension

中文文档
1.0.1发布于 2026/10/06MPL-2.0CommonJS近 30 天下载 2.6万

An Antora extension that uses Assembler to merge pages into assembly files, export them to the PDF format, and publish them with the site.

原始使用文档
中文原文

Antora PDF Extension

The Antora PDF extension is an Antora extension and exporter for Assembler. It configures and invokes Assembler and provides the converter function and metadata Assembler uses to export content to the PDF format. This extension is the official extension for exporting content in an Antora site to PDF.

This extension first delegates to Assembler, passing in the converter metadata, to construct assembly files from pages per component version using the navigation as a model. Assembler then iterates over those assembly files and, using the converter provided by this extension, converts them to PDF using Asciidoctor PDF (or the specified command). Finally, Assembler adds those PDFs to the content catalog as exports, which Antora publishes alongside the other files in the site.

Usage

Once this package is installed in the playbook project, register it in the Antora playbook as follows:

antora-playbook.yml

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

You can configure the behavior of the extension using the optional configuration file, named antora-assembler.yml by default. When using more than one exporter extension, you likely want to use a dedicated configuration file named according to the export filetype (e.g., antora-assembler-pdf.yml). The configuration file can be specified using the config_file key on the extension entry.

Copyright (C) 2022-present by OpenDevise Inc. and the individual contributors of this project.

Use of this software is granted under the terms of the Mozilla Public License Version 2.0 (MPL-2.0).

版本与发布记录

@antora/pdf-extension 共发布 46 个版本，首次发布于 2022/05/26；过去 12 个月发布了 21 个版本。

版本发布日期距今
1.0.1latest2026/10/061 个月前
1.0.02026/09/012 个月前
1.0.0-rc.122026/08/302 个月前
1.0.0-rc.112026/08/252 个月前
1.0.0-rc.102026/08/232 个月前
1.0.0-rc.92026/08/152 个月前

关于 @antora/pdf-extension 的常见问题

@antora/pdf-extension 是什么？

An Antora extension that uses Assembler to merge pages into assembly files, export them to the PDF format, and publish them with the site.

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