DocRaptor

Documentation

HTML-to-PDF with Ruby

Test API Key: YOUR_API_KEY_HERE

Code Examples

Installation

Add the following to your Gemfile.

gem "docraptor"

Then run:

bundle install

Usage

Below is a barebones example, more robust examples with file output and error handling, asynchronous generation, hosted documents, or asynchronous hosted documents are also available.

DocRaptor.configure do |config|
  config.username = "YOUR_API_KEY_HERE"
  # config.debugging = true
end

$docraptor = DocRaptor::DocApi.new

response = $docraptor.create_doc(
  test:             true,                                         # test documents are free but watermarked
  document_content: "<html><body>Hello World</body></html>",      # supply content directly
  # document_url:   "http://docraptor.com/examples/invoice.html", # or use a url
  name:             "docraptor-ruby.pdf",                         # help you find a document later
  document_type:    "pdf",                                        # pdf or xls or xlsx
  # javascript:       true,                                       # enable JavaScript processing
  # prince_options: {
  #   media: "screen",                                            # use screen styles instead of print styles
  #   baseurl: "http://hello.com",                                # pretend URL when using document_content
  # },
)

Documents created synchronously like above are limited to 60 seconds of generation time, the asynchronous method allows up to 10 minutes.

Our styling documentation and knowledge base contain tips and guides on creating headers, footers, page numbers, table of contents, and much more.

With DocRaptor, it's fast and painless to convert HTML, CSS, and JavaScript into PDF and XLS documents with Ruby. Below are working Ruby examples for creating documents. Our API reference lists all the generation options and our style and formatting guide will help make it look perfect.