wkhtmltopdf 和 wkhtmltoimage 技术文档

1. 安装指南

1.1 下载预编译二进制文件

您可以从 wkhtmltopdf 官方网站 下载预编译的二进制文件。根据您的操作系统选择合适的版本进行下载。

1.2 源码编译

如果您需要从源码编译 wkhtmltopdf，请参考以下步骤：

1. 克隆 wkhtmltopdf 的源码仓库：

   git clone https://github.com/wkhtmltopdf/wkhtmltopdf.git
   

2. 进入项目目录：

   cd wkhtmltopdf
   

3. 按照项目 README 文件中的说明进行编译。

2. 项目的使用说明

2.1 基本用法

wkhtmltopdf 和 wkhtmltoimage 是命令行工具，用于将 HTML 渲染为 PDF 和各种图像格式。以下是基本用法示例：

• 将 HTML 文件转换为 PDF：

  wkhtmltopdf input.html output.pdf
  

• 将网页转换为 PDF：

  wkhtmltopdf http://example.com example.pdf
  

• 将 HTML 文件转换为图像：

  wkhtmltoimage input.html output.png
  

2.2 高级选项

wkhtmltopdf 提供了丰富的命令行选项，您可以通过 --help 查看所有可用选项。例如，添加目录、设置页面大小等。

3. 项目API使用文档

3.1 命令行接口

wkhtmltopdf 和 wkhtmltoimage 主要通过命令行接口进行操作。以下是一些常用的命令行选项：

• --page-size：设置页面大小（如 A4、Letter 等）。
• --margin-top、--margin-bottom、--margin-left、--margin-right：设置页面的上下左右边距。
• --toc：生成目录。
• --footer-html、--header-html：指定页眉和页脚的 HTML 文件。

3.2 示例

以下是一个使用多个选项的示例：

wkhtmltopdf --page-size A4 --margin-top 20mm --margin-bottom 20mm --toc input.html output.pdf

4. 项目安装方式

4.1 通过包管理器安装

在某些操作系统上，您可以通过包管理器安装 wkhtmltopdf。例如，在 Ubuntu 上可以使用以下命令：

sudo apt-get install wkhtmltopdf

4.2 手动安装

如果您无法通过包管理器安装，可以手动下载并安装预编译的二进制文件。下载后，解压缩并将可执行文件放置在系统的 PATH 中。

4.3 源码编译安装

如果您需要从源码编译安装，请参考 Building 部分的内容。

---

通过以上文档，您应该能够顺利安装和使用 wkhtmltopdf 和 wkhtmltoimage 工具。如有任何问题，请参考官方文档或社区支持。