HTML to PDF using Ruby
The Ruby gem for converting HTML files to PDF files using Google Chrome browser.
HTML to PDF features
The Ruby SDK for converting HTML files to PDF files.
ConvertAPI Ruby library install
ConvertAPI provides a Ruby Gem that allows you to perform a HTML to PDF conversion with just a few lines of code. First, install the ConvertAPI Ruby SDK:
gem 'convert_api'
Authenticate your Ruby library
You can obtain your secret key by signing up for a free account. Once you sign up, you'll receive 250 free conversions instantly! Grab your authentication secret from the account dashboard, and authenticate the ConvertAPI Ruby library like this:
ConvertApi.configure do |config|
config.api_credentials = 'secret_or_token'
end
Convert HTML to PDF using Ruby in no time!
Once you have your authentication in place, simply copy-paste this html to pdf conversion code snippet into your Ruby project:
Try the conversion online - no coding required!
You can try out advanced conversion parameters and test the conversion result online using our interactive demo tool. This tool will produce the same conversion output as if you were using the library from your solution, and it will auto-generate the code snippet for you!
Try for FREE!Conversion parameters
HTTP authentication username. Could be used if conversion web page is protected with HTTP authentication.
HTTP authentication password. Could be used if conversion web page is protected with HTTP authentication.
Set additional cookies for the page request. Example: cookiename1=cookievalue1; cookiename2=cookievalue2; cookiename3=cookievalue3
Set page range. Example 1-10 or 1,2,5.
Delay in seconds before page load and PDF creation. Sometimes useful to let web page fully load.
Block ads in converting page.
Tries to remove EU regulation required cookie warnings from web pages.
Allow web pages to run JavaScript.
Element selector string of the DOM element. Converter will wait for this element to appear in DOM before conversion begins.
Execute provided JavaScript before conversion begins.
Apply additional CSS before conversion begins.
Element selector string of the DOM elements that needs to be hidden during conversion.
Use CSS media type in conversion process. The default screen and print media types are supported but not limited to these. The custom media type, like convertapi can be used too.
Specify a particular version of the Chromium engine to render the web page.
Values: latest 126 117
Load page images that loads only when they are visible.
Sets browser viewport width.
Sets browser viewport height.
Convert web page background.
Change fixed elements CSS 'position' property to adapt page for conversion.
Values: fixed absolute relative hide
Element selector string of the DOM elements that should be visible during conversion. Other elements will be hidden.
CSS selector for the elements that pages should not break.
CSS selector for the elements that should apply page break before it.
CSS selector for the elements that should apply page break after it.
If true, the converter will generate PDF as the content looks like in the browser. If is set to false, the converter acts like Chrome print to PDF function.
Set web page scale value in percentage.
PDF page orientation.
Values: portrait landscape
PDF page size.
Values: a0 a1 a2 a3 a4 a5 a6 a7 a8 a9 b0 b1 b2 b3 b4 b5 letter legal ledger
Set the page top margin in millimeters (mm).
Set the page right margin in millimeters (mm).
Set the page bottom margin in millimeters (mm).
Set the page left margin in millimeters (mm).
This property will insert an HTML header into each page. HTML tags containing the classes pageNumber
, totalPages
, title
, and date
will be filled in with the metadata relevant to each individual page. Inline CSS could be utilized to style the HTML provided.
<style> .right { float: right; } .left { float: left; } </style> <span class='left'> page number <span class='pageNumber'></span> </span> <span class='right'> date <span class='date'></span> </span>
This property will insert an HTML footer into each page. HTML tags containing the classes pageNumber
, totalPages
, title
, and date
will be filled in with the metadata relevant to each individual page. Inline CSS could be utilized to style the HTML provided.
<style> .right { float: right; } .left { float: left; } </style> <span class='left'> page number <span class='pageNumber'></span> </span> <span class='right'> date <span class='date'></span> </span>
Custom page width in millimeters (mm). This option override PageSize option.
Custom page height in millimeters (mm). This option override PageSize option.
It tries to produce smaller output files but requires Adobe Reader 6, released in 2003 or newer, to view created PDF files.