使用node-html-pdf将HTML转换为PDF的指南

一、项目介绍

node-html-pdf是基于PhantomJS的一个Node.js库，它能够将HTML文件转换成PDF文件，提供了高度定制化的能力，包括设置页边距、纸张大小、方向以及添加页眉页脚等功能。该库适用于网页抓取场景下的PDF创建需求。

然而需要注意的是，由于PhantomJS已经被废弃了很长时间，这个仓库不再维护。因此建议用户迁移到基于Headless Chrome或Puppeteer的解决方案上。对于那些仍然使用PhantomJS并想继续维护其应用程序的人来说，node-html-pdf提供了一个强大的工具集来处理HTML到PDF的转化。

二、项目快速启动

安装

首先确保你的环境中已安装Node.js和npm，然后可以通过以下命令全局安装html-pdf：

$ npm install -g html-pdf

快速示例代码

命令行方式

$ html-pdf test/businesscard.html businesscard.pdf

Node.js代码示例

var fs = require('fs');
var pdf = require('html-pdf');

var html = fs.readFileSync('/path/to/test/businesscard.html', 'utf8');
var options = { format: 'Letter' };

pdf.create(html, options).toFile('/path/to/businesscard.pdf', function(err, res) {
    if (err) return console.log(err);
    console.log(res); // { filename: '/path/to/businesscard.pdf' }
});

三、应用案例和最佳实践

创建带有页眉和页脚的PDF

在HTML中，你可以通过ID pageHeader 和 pageFooter 来定义默认页眉和页脚的内容。也可以针对特定页面自定义页眉和页脚。

例如，在HTML文件中可以这样定义：

<div id="pageHeader">Default header</div>
<div id="pageHeader-first">Header on first page</div>
...
<div id="pageFooter">Default footer</div>
<div id="pageFooter-first">Footer on first page</div>
...

高级选项配置

可以设置更多渲染选项，如纸张尺寸、页边距、基路径等。

var options = {
    format: 'A4',
    orientation: 'landscape',
    border: {
        top: '2in',
        right: '1in',
        bottom: '2in',
        left: '1.5in'
    },
    base: 'http://localhost:8080/assets/'
};

四、典型生态项目

虽然node-html-pdf已经不被推荐用于新项目，但如果你已经在现有系统中使用它，那么考虑转向更新的框架，如Puppeteer，它可以更高效地利用现代浏览器特性进行截图和PDF生成。这类替代方案通常提供更好的性能和稳定性，适合持续集成、自动化测试和数据报告等应用场景。

---

以上就是关于如何使用node-html-pdf进行HTML转PDF的基本介绍和操作指南。希望对您有所帮助！

请注意：上述指引中的某些功能可能已经过时或不受支持，建议根据最新版本的项目说明进行相应调整。