# @diplodoc/pdf-generator 中文文档

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

版本：2\.0\.0
npm 元数据更新时间：2026-11-06T09:30:14.594Z
中文译文更新时间：2026-11-12T12:23:27.359Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：20.1 MB，13 个文件
- 模块格式：CommonJS
- TypeScript 类型：未声明
- 运行依赖：7 个
- 首次发布：2024-06-21T09:53:19.769Z
- 最新版本发布：2026-11-06T09:30:14.021Z
- 近 30 天下载量：3358（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：37（近 12 个月 22 个）

## 中文简介

将 Diplodoc 项目转换为 PDF 软件包

## 安装

```sh
npm install @diplodoc/pdf-generator
```

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

## README

# pdf 生成器

将 Diplodoc 项目变成PDF 软件包 .

## 安装

```
npm i -g @diplodoc/pdf-generator
```

## 使用量

### 步骤1:生成单页文件

运行 `@diplodoc/cli` 命令。 这将为每个目录(TOC)文件创建一个输出文件夹,并有一个单页文件.

```
npx -- @diplodoc/cli@latest -i ./docs -o ./docs-output --pdf
```

### 步骤2: 将单页文件转换为 PDF

运行 `@diplodoc/pdf-generator` 命令。 这将在单个页面文件旁边创建 PDF 文件 .

```
npx -- @diplodoc/pdf-generator@latest -i ./docs-output
```

该工具还以HTML格式文件的形式为用户提供了对信头和页脚的灵活定制,其路径可以通过相应的选项 -- -- Custom-header和 -- Custom-footer.

默认情况下,页眉没有设置,但右下角的页码设置在页脚上,如下文示例所示.

```
npx -- @diplodoc/pdf-generator@latest -i ./docs-output
```

下面还有一个带有自定义标题的命令的例子([示例- 客户头. html](https://github.com/diplodoc-platform/pdf-generator/blob/master/example-custom-header.html))和自定义页脚([实例- footer.html](https://github.com/diplodoc-platform/pdf-generator/blob/master/example-custom-footer.html)) (中文(简体) ).  
即使您指定了自定义页脚,编号仍然保留在右下角.

```
npx -- @diplodoc/pdf-generator@latest -i ./docs-output --custom-header ./example-custom-header.html --custom-footer ./example-custom-footer.html
```

### 通过参数

| 选项 | 类型 | 必要的 | 默认值 | 说明 |
| --- | --- | --- | --- | --- |
| `custom-header` | `string` (filepath) (英语) | 没有 | "" "" (英语) | HTML 文件路径, 包含生成的 PDF 页面的自定义标题内容 . |
| `custom-footer` | `string` (filepath) (英语) | 没有 | `<div style="position: relative;width: 100%;height: 0;"><div style="position: absolute;right: 20px;bottom: 0;font-size: 10px;z-index: 0;padding: 0 5px;background: white;"><span class="pageNumber"></span></div></div>` | HTML 文件路径, 包含生成的 PDF 页面的自定义页脚内容 . |

屏幕截图上有自定义页眉和页脚的生成的 pdf 页面示例 **测试**编号 :**图像相片( s)** /海关负责人-测试-ts-整合-工作-页面\*

## 发展

### 先决条件

-   节点 18.x
-   图形映射
-   幽灵标记

#### 没有图形磁体和幽灵记录吗?

跟随 [这个](https://github.com/yakovmeister/pdf2image/blob/HEAD/docs/gm-installation.md) 用于安装所需依赖的指南.

### 运行测试

```
npm run test
```

## 常见问题

### @diplodoc/pdf-generator 是什么？

将 Diplodoc 项目转换为 PDF 软件包

### 如何安装 @diplodoc/pdf-generator？

在项目目录运行 npm install @diplodoc/pdf-generator，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 pdf-generator，可以用 npx pdf-generator 直接运行。

### @diplodoc/pdf-generator 支持 TypeScript 吗？

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

### @diplodoc/pdf-generator 支持 ESM 还是 CommonJS？

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

### @diplodoc/pdf-generator 可以商用吗？

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

### @diplodoc/pdf-generator 的下载量有多少？

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

### @diplodoc/pdf-generator 还在维护吗？

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