首页
/ PDFKit 技术文档

PDFKit 技术文档

2024-12-23 06:34:17作者:齐添朝

1. 安装指南

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

安装 PDFKit

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

gem install pdfkit

安装 wkhtmltopdf

  1. 手动安装(推荐):

    请访问 PDFKit GitHub Wiki 查看详细步骤。

  2. 尝试使用 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 的技术文档,希望对您有所帮助。

登录后查看全文
热门项目推荐

热门内容推荐

最新内容推荐

项目优选

收起
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
176
262
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
863
511
ShopXO开源商城ShopXO开源商城
🔥🔥🔥ShopXO企业级免费开源商城系统,可视化DIY拖拽装修、包含PC、H5、多端小程序(微信+支付宝+百度+头条&抖音+QQ+快手)、APP、多仓库、多商户、多门店、IM客服、进销存,遵循MIT开源协议发布、基于ThinkPHP8框架研发
JavaScript
93
15
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
129
182
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
259
300
kernelkernel
deepin linux kernel
C
22
5
cherry-studiocherry-studio
🍒 Cherry Studio 是一款支持多个 LLM 提供商的桌面客户端
TypeScript
596
57
CangjieCommunityCangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
1.07 K
0
HarmonyOS-ExamplesHarmonyOS-Examples
本仓将收集和展示仓颉鸿蒙应用示例代码,欢迎大家投稿,在仓颉鸿蒙社区展现你的妙趣设计!
Cangjie
398
371
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
332
1.08 K