lloeki/tilt-pdf-rails
1
0
Fork 0
mirror of https://github.com/lloeki/tilt-pdf-rails.git synced 2025-12-06 02:24:42 +01:00
Code Issues Projects Releases Packages Wiki Activity
Generate PDF with Rails and Tilt::PDF
14 commits 1 branch 2 tags 154 KiB
Find a file
Loic Nageleisen bc91aa7012 extended auxiliary files support 
- support for css in header/footer
- support for js/coffee/whatever
- main integrated into render/inject/tmp flow

=> all html files get every css/js injected
2014-02-21 16:14:18 +01:00
bin rudimentary command line generator tool 2014-02-20 14:37:55 +01:00
lib extended auxiliary files support 2014-02-21 16:14:18 +01:00
.gitignore first version 2013-10-22 17:41:08 +02:00
.rubocop.yml first version 2013-10-22 17:41:08 +02:00
Gemfile first version 2013-10-22 17:41:08 +02:00
Gemfile.lock extended auxiliary files support 2014-02-21 16:14:18 +01:00
LICENSE first version 2013-10-22 17:41:08 +02:00
README.mdown doc fixes 2013-10-22 17:42:07 +02:00
tilt-pdf.gemspec extended auxiliary files support 2014-02-21 16:14:18 +01:00

README.mdown

Tilt::PDF

Integrates PDF generation into a Tilt flow

Dependencies

This gem depends on PDFKit, which in turn requires wkhtmltopdf. It is recommended to use the statically compiled version of the latter, as it is built against a patched QT that supports more features.

Usage as a Tilt template

Add tilt-pdf to your Gemfile. Also add any template engine you may optionally want, such as less or slim.

A foo template is currently threefold:

  • foo.rpdf: this file is a YAML file containing options pertaining to the PDF generation process, such as page size, orientation and metadata. Options are apssed as is to PDFKit, and subsequently to wkhtmltopdf.
  • foo.html: this document can be written in any template language you need (such as ERB or Slim), and the Tilt template resolution system via extension chaining will apply. Tilt will pass the render block to be yielded to this document.
  • foo.css: this stylesheet can be written in any template language you need (such as Sass or Less), and the Tilt template resolution system via extension chaining will apply. Tilt will not pass the block to be yielded to this template.

The three files must currently be stored in the same directory.

Rendering is done the usual Tilt way:

require 'tilt-pdf'

pdf = Tilt.new('foo.rpdf').render()

Rails and ActionView integration

Require tilt/pdf/rails if you want to set up and register tilt-pdf as an ActionView template handler. You can do it in an initializer, or straight from the Gemfile:

gem 'tilt-pdf', require: 'tilt/pdf/rails'

Put your three template files together in the relevant app/views/foo view directory. Work is in progress to enable better integration with Rails file layout.