【亲测免费】 node-html-pdf 项目安装和配置指南

2026-01-25 05:29:31作者：裘旻烁

1. 项目基础介绍和主要的编程语言

node-html-pdf 是一个用于将 HTML 文件转换为 PDF 文件的开源项目。该项目主要使用 JavaScript 作为编程语言，并且依赖于 Node.js 环境运行。通过 node-html-pdf，开发者可以轻松地将 HTML 页面转换为 PDF 文件，适用于生成报告、发票、合同等文档。

2. 项目使用的关键技术和框架

node-html-pdf 项目主要依赖以下关键技术和框架：

Node.js: 项目运行在 Node.js 环境中，因此需要安装 Node.js。
PhantomJS: 该项目早期版本依赖于 PhantomJS，但 PhantomJS 已经不再维护，建议迁移到 Headless Chrome 或 Puppeteer。
HTML/CSS: 用于定义需要转换的 HTML 页面内容和样式。

3. 项目安装和配置的准备工作和详细的安装步骤

3.1 准备工作

在开始安装 node-html-pdf 之前，请确保你的系统已经安装了以下软件：

Node.js: 建议使用最新版本的 Node.js。你可以通过 Node.js 官网下载并安装。
npm: Node.js 自带 npm 包管理器，确保 npm 已经安装并可用。

3.2 安装步骤

3.2.1 创建项目目录

首先，创建一个新的项目目录，并在该目录下初始化一个新的 Node.js 项目。

mkdir my-pdf-project
cd my-pdf-project
npm init -y

3.2.2 安装 `node-html-pdf`

在项目目录下，使用 npm 安装 node-html-pdf 包。

npm install html-pdf

3.2.3 创建 HTML 文件

在项目目录下创建一个 HTML 文件，例如 example.html，内容如下：

<!DOCTYPE html>
<html lang="zh-CN">
<head>
    <meta charset="UTF-8">
    <title>示例页面</title>
    <style>
        body {
            font-family: Arial, sans-serif;
            padding: 20px;
        }
        h1 {
            color: #333;
        }
    </style>
</head>
<body>
    <h1>这是一个示例页面</h1>
    <p>这是一些示例文本。</p>
</body>
</html>

3.2.4 编写 Node.js 脚本

在项目目录下创建一个 Node.js 脚本文件，例如 generate-pdf.js，内容如下：

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

// 读取 HTML 文件内容
const html = fs.readFileSync('./example.html', 'utf8');

// 配置 PDF 生成选项
const options = {
    format: 'Letter', // 纸张格式
    orientation: 'portrait', // 页面方向
    border: '10mm' // 页面边距
};

// 生成 PDF 文件
pdf.create(html, options).toFile('./example.pdf', function(err, res) {
    if (err) return console.log(err);
    console.log('PDF 文件已生成:', res.filename);
});