PDFKit 技术文档

2024-12-23 13:05:52作者：齐添朝

1. 安装指南

PDFKit 是一个用于生成 PDF 文件的工具，它使用 HTML 和 CSS 作为输入，并依赖于 wkhtmltopdf 在后端渲染 WebKit。

安装 PDFKit

在命令行中执行以下命令来安装 PDFKit：

gem install pdfkit

安装 wkhtmltopdf

手动安装（推荐）：

请访问 PDFKit GitHub Wiki 查看详细步骤。
尝试使用 wkhtmltopdf-binary-edge gem（适用于 macOS 和 Linux i386）：
```
gem install wkhtmltopdf-binary
```
注意： 自动安装程序已被移除。

2. 项目的使用说明

以下是如何使用 PDFKit 的示例：

# 创建一个新的 PDFKit 对象
kit = PDFKit.new(html, :page_size => 'Letter')
kit.stylesheets << '/path/to/css/file'

# 获取内联 PDF
pdf = kit.to_pdf

# 将 PDF 保存到文件
file = kit.to_file('/path/to/save/pdf')

PDFKit.new 可以接受一个 URL 或 File 对象作为输入。如果输入是 URL 或 File，则无法添加样式表。

kit = PDFKit.new('http://google.com')
kit = PDFKit.new(File.new('/path/to/html'))

您还可以通过 meta 标签添加选项：

PDFKit.new('<html><head><meta name="pdfkit-page_size" content="Letter"')
PDFKit.new('<html><head><meta name="pdfkit-cookie cookie_name1" content="cookie_value1"')
PDFKit.new('<html><head><meta name="pdfkit-cookie cookie_name2" content="cookie_value2"')

3. 项目 API 使用文档

以下是 PDFKit 的一些常用方法：

PDFKit.new(html, options)：创建一个新的 PDFKit 对象，其中 html 是要转换为 PDF 的 HTML 内容，options 是传递给 wkhtmltopdf 的选项。
kit.to_pdf：将 HTML 转换为内联 PDF。
kit.to_file(path)：将 PDF 保存到指定路径的文件。

以下是一些选项的例子：

:page_size：设置页面大小，例如 'Letter' 或 'A4'。
:print_media_type：设置是否打印媒体类型。

PDFKit.new(html, root_url: 'http://mysite.com/').to_file
# 或者：
PDFKit.new(html, protocol: 'https').to_file

使用 cookies 进行抓取：

kit = PDFKit.new(url, cookie: {cookie_name: :cookie_value})
kit = PDFKit.new(url, [:cookie, :cookie_name1] => :cookie_val1, [:cookie, :cookie_name2] => :cookie_val2)