node-html-pdf 安装与使用教程

node-html-pdf 安装与使用教程

node-html-pdfThis repo isn't maintained anymore as phantomjs got dreprecated a long time ago. Please migrate to headless chrome/puppeteer.项目地址:https://gitcode.com/gh_mirrors/no/node-html-pdf

1. 项目目录结构及介绍

在 node-html-pdf 的源代码仓库中，主要目录结构如下：

• examples：包含了一些使用示例代码。
• lib：核心库文件，实现了 HTML 到 PDF 的转换逻辑。
• test：测试用例，用于验证模块的功能。
• .gitignore 和 npmignore：分别定义了 Git 和 NPM 忽略的文件和目录。
• travis.yml：持续集成配置文件，用于自动构建和测试。
• LICENSE：项目授权协议。
• README.md：项目简介和使用指南。
• package-lock.json 和 package.json：NPM 包管理相关的文件。

该项目的核心是通过调用 PhantomJS 来生成 PDF，但请注意，由于 PhantomJS 已被弃用，这个项目可能不再维护。

2. 项目的启动文件介绍

node-html-pdf 模块通常不会像一个独立应用那样运行，而是作为一个 Node.js 库来使用。你可以通过以下方式在你的代码中导入和使用它：

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

// ... 之后创建 PDF 文件

你不需要一个特定的启动文件，因为该库提供了一个 API 来创建 PDF，就像上面的代码所示。你可以在自己的应用程序中按需调用这个 API。

3. 项目的配置文件介绍

node-html-pdf 使用 JavaScript 对象作为配置参数，以便定制 PDF 输出。以下是一些关键配置选项的说明：

• directory: PDF 文件保存的目录，默认为 /tmp。
• paperSize: 纸张大小设置，例如高度、宽度或预设格式（如 A4、Letter）等。
• orientation: 纸张方向，可以是 portrait 或 landscape。
• border: 边距设置，支持毫米、厘米、英寸或像素单位。
• paginationOffset: 自定义起始页码。
• header 和 footer: 分别设置页面的头部和底部内容，可以包括固定部分和动态页数显示。
• base: 作为加载资源（如图片、CSS、JS）的基础路径。
• zoomFactor: 缩放因子，用于调整图像尺寸。
• type: 输出类型，默认为 pdf，还可以选择 png 或 jpeg。

以下是一个简单的配置示例：

var options = {
  format: 'Letter',
  orientation: 'portrait',
  border: {
    top: '2cm',
    right: '1cm',
    bottom: '2cm',
    left: '1.5cm'
  },
  header: {
    height: '45mm',
    contents: '<div style="text-align: center;">Author: Marc Bachmann</div>'
  },
  footer: {
    height: '28mm',
    contents: {
      first: 'Cover page',
      2: 'Second page',
      default: '<span style="color: #444;">[[page]]</span>/<span>[[pages]]</span>'
    }
  }
};

以上就是关于 node-html-pdf 的安装与使用的基本介绍，通过这个库，你可以轻松地将 HTML 文档转换为高质量的 PDF 文件。

node-html-pdfThis repo isn't maintained anymore as phantomjs got dreprecated a long time ago. Please migrate to headless chrome/puppeteer.项目地址:https://gitcode.com/gh_mirrors/no/node-html-pdf