ccjmne/puppeteer-html2pdf

通过Web服务器将HTML转换为PDF。

内置功能

这是一个简单的Express服务器，监听POST请求，接收任意HTML内容并将其转换为PDF，用于生成精美的报告。

使用的技术：

• Docker
• https://github.com/GoogleChrome/puppeteer
• Express
• NodeJS

提供适用于ARM和AMD架构的镜像。

快速开始

以下示例（可直接复制粘贴到shell解释器中）将在端口3000上运行服务，并将简单的HTML文档转换为PDF。

docker run --name html2pdf --detach --publish=3000:3000 --memory 500M ghcr.io/ccjmne/puppeteer-html2pdf:latest
# 首次启动时可能需要几秒钟预计算字体缓存
until curl -q localhost:3000 >/dev/null 2>&1; do sleep 0.1; done

# 或快速测试（按Ctrl-C终止）：
# docker run -it --rm -p=3000:3000 ghcr.io/ccjmne/puppeteer-html2pdf:latest

curl localhost:3000 -H 'Content-Type: text/html' --data '
Hello World!

I love deadlines. I like the whooshing sound they make as they fly by.

— Douglas Adams

'
> out.pdf && xdg-open out.pdf

Docker环境变量

设置PDF信息字典

PDF信息字典的属性也可通过查询参数控制，包括：

其中五个参数提供默认值：

自定义字体

添加字体的最简单方法是将包含所需字体的卷挂载到容器内的/usr/share/fonts目录。

# 获取字体
longcang=$(curl -L 'https://fonts.googleapis.com/css2?family=Long+Cang' | grep -Po '(?

我也支持自定义字体！
鉴于对人类家庭所有成员的固有尊严及其平等的和不移的权利的承认,乃是世界自由、正义与和平的基础

'
> out.pdf && xdg-open out.pdf

端点

Web服务器监听您选择的端口（参见快速开始部分），并公开以下两个端点：

单页文档，默认设置（格式：A4，方向：portrait）：

所有端点均支持以下查询参数：

• filename：生成的PDF文件名（如果缺少，将自动追加.pdf扩展名）
• onepage：true表示强制为每个URL或HTML文档创建单个（可能很大的）页面。如果设置，将覆盖format和landscape
• 所有PDF信息字典的属性（trapped除外）：
  • title
  • author
  • subject
  • keywords（可提供多个，例如：?keywords=travelling&keywords=korea&keywords=beautiful）
  • creator
  • producer
  • creationDate（按ISO-8601解析，例如：2025-12-28）
  • modDate（按ISO-8601解析，例如：2025-12-28）
• 所有https://github.com/puppeteer/puppeteer/blob/main/docs/api.md#pagepdfoptions%E6%94%AF%E6%8C%81%E7%9A%84%E9%80%89%E9%A1%B9%EF%BC%88%E4%BB%A5%E4%B8%8B%E9%99%A4%E5%A4%96%EF%BC%89%EF%BC%9A
  • path
  • headerTemplate
  • margin

示例

单页文档，默认设置（格式：A4，方向：portrait）：

curl 'http://localhost:3000' \
-H 'Content-Type: text/html' \
-d ' Hello World! ' \
> out.pdf && xdg-open out.pdf

单页文档（格式：A3，方向：landscape）：

curl 'http://localhost:3000?format=a3&landscape=true' \
-H 'Content-Type: text/html' \
-d ' Hello World! ' \
> out.pdf && xdg-open out.pdf

指定信息字典：

curl 'http://localhost:3000?author=ccjmne&title=Hello+World' \
-H 'Content-Type: text/html' \
-d ' Hello World! ' \
> out.pdf && xdg-open out.pdf

多页文档：

curl 'http://localhost:3000/multiple' \
-H 'Content-Type: application/json' \
-d '[
" Hello World! ",
"This is the second page"
]' \
> out.pdf && xdg-open out.pdf

将网页转换为PDF：

curl 'http://localhost:3000/url?onepage=true' \
-H 'Content-Type: text/plain' \
-d 'https://justinjackson.ca/webmaster/' \
> out.pdf && xdg-open out.pdf

将多个网页转换为单个PDF：

curl 'http://localhost:3000/url?onepage=true' \
-H 'Content-Type: text/plain' \
-d '
' \
> out.pdf && xdg-open out.pdf

维护者说明

每次GitHub Release时自动构建并发布到GitHub Packages（GitHub容器注册表）。

包含一个全面的脚本，可用于构建和发布镜像的新版本：./compose.sh

待办事项

• 支持将截图作为图像打印
• 重命名为html-printer？
• 提供纯TypeScript库而非Web服务器
• 将库发布到npm

许可证

MIT。随意使用。 有关更多详情，请参阅LICENSE文件。