PDFKit 技术文档
2024-12-17 05:05:44作者:齐添朝
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)
4. 项目安装方式
请参考“安装指南”部分,使用以下命令安装 PDFKit:
gem install pdfkit
同时,确保您已经安装了 wkhtmltopdf。安装方式请参考“安装指南”部分。
以上是关于 PDFKit 的技术文档,希望对您有所帮助。
热门项目推荐
相关项目推荐
- mybatis-plusmybatis 增强工具包,简化 CRUD 操作。 文档 http://baomidou.com 低代码组件库 http://aizuda.comJava00
- open-eBackupopen-eBackup是一款开源备份软件,采用集群高扩展架构,通过应用备份通用框架、并行备份等技术,为主流数据库、虚拟化、文件系统、大数据等应用提供E2E的数据备份、恢复等能力,帮助用户实现关键数据高效保护。HTML051
- 每日精选项目🔥🔥 12.25日推荐:优秀 LLM 应用程序集合🔥🔥 每日推荐行业内最新、增长最快的项目,快速了解行业最新热门项目动态~~017
- Cangjie-Examples本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。Cangjie041
- 毕方Talon工具本工具是一个端到端的工具,用于项目的生成IR并自动进行缺陷检测。Python039
- PDFMathTranslatePDF scientific paper translation with preserved formats - 基于 AI 完整保留排版的 PDF 文档全文双语翻译,支持 Google/DeepL/Ollama/OpenAI 等服务,提供 CLI/GUI/DockerPython03
- advanced-javaAdvanced-Java是一个Java进阶教程,适合用于学习Java高级特性和编程技巧。特点:内容深入、实例丰富、适合进阶学习。JavaScript0102
- taro开放式跨端跨框架解决方案,支持使用 React/Vue/Nerv 等框架来开发微信/京东/百度/支付宝/字节跳动/ QQ 小程序/H5/React Native 等应用。 https://taro.zone/TypeScript09
- Yi-CoderYi Coder 编程模型,小而强大的编程助手HTML012
- excelizehttps://github.com/xuri/excelize Excelize 是 Go 语言编写的一个用来操作 Office Excel 文档类库,基于 ECMA-376 OOXML 技术标准。可以使用它来读取、写入 XLSX 文件,相比较其他的开源类库,Excelize 支持操作带有数据透视表、切片器、图表与图片的 Excel 并支持向 Excel 中插入图片与创建简单图表,目前是 Go 开源项目中唯一支持复杂样式 XLSX 文件的类库,可应用于各类报表平台、云计算和边缘计算系统。Go02
热门内容推荐
最新内容推荐
项目优选
收起
openHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
48
38
HarmonyOS-Examples
本仓将收集和展示仓颉鸿蒙应用示例代码,欢迎大家投稿,在仓颉鸿蒙社区展现你的妙趣设计!
Cangjie
250
63
mybatis-plus
mybatis 增强工具包,简化 CRUD 操作。 文档 http://baomidou.com
低代码组件库 http://aizuda.com
Java
14
0
Cangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
173
41
open-eBackup
open-eBackup是一款开源备份软件,采用集群高扩展架构,通过应用备份通用框架、并行备份等技术,为主流数据库、虚拟化、文件系统、大数据等应用提供E2E的数据备份、恢复等能力,帮助用户实现关键数据高效保护。
HTML
69
51
advanced-java
Advanced-Java是一个Java进阶教程,适合用于学习Java高级特性和编程技巧。特点:内容深入、实例丰富、适合进阶学习。
JavaScript
395
102
HarmonyOS-Cangjie-Cases
参考 HarmonyOS-Cases/Cases,提供仓颉开发鸿蒙 NEXT 应用的案例集
Cangjie
54
2
PDFMathTranslate
PDF scientific paper translation with preserved formats - 基于 AI 完整保留排版的 PDF 文档全文双语翻译,支持 Google/DeepL/Ollama/OpenAI 等服务,提供 CLI/GUI/Docker
Python
31
3
RuoYi-Cloud-Vue3
🎉 基于Spring Boot、Spring Cloud & Alibaba、Vue3 & Vite、Element Plus的分布式前后端分离微服务架构权限管理系统
Vue
25
17
topiam-eiam
开源IDaas/IAM平台,用于管理企业内员工账号、权限、身份认证、应用访问,帮助整合部署在本地或云端的内部办公系统、业务系统及三方 SaaS 系统的所有身份,实现一个账号打通所有应用的服务。
Java
19
0