PDF to HTML Ruby Examples

Complete Ruby examples for common PDF to HTML tasks. See the Ruby SDK guide for installation and result handling.

You can run the examples below with the displayed API credentials. Update the input URLs and filenames as needed. Each Ruby example can be copied and run independently.

Basic examples

Choose file, in-memory, or output-stream handling for the HTML result. Stream examples use a binary file stream as their destination.

The memory variants return UTF-8 bytes. Decode them when your application needs a text string.

Convert a PDF file

Upload an existing logo.pdf file.

Save to a file

require 'pdfcrowd'

client = Pdfcrowd::PdfToHtmlClient.new('demo', 'demo')

client.convertFileToFile('logo.pdf', 'logo.html')

Keep in memory

require 'pdfcrowd'

client = Pdfcrowd::PdfToHtmlClient.new('demo', 'demo')

html_bytes = client.convertFile('logo.pdf') # binary String
puts html_bytes.bytesize

Write to a stream

require 'pdfcrowd'

client = Pdfcrowd::PdfToHtmlClient.new('demo', 'demo')

File.open('logo.html', 'wb') do |output_stream|
  client.convertFileToStream('logo.pdf', output_stream)
end

Convert a URL

Fetch a PDF from its URL.

Save to a file

require 'pdfcrowd'

client = Pdfcrowd::PdfToHtmlClient.new('demo', 'demo')

client.convertUrlToFile('https://your-server.com/invoice.pdf', 'invoice.html')

Keep in memory

require 'pdfcrowd'

client = Pdfcrowd::PdfToHtmlClient.new('demo', 'demo')

html_bytes = client.convertUrl('https://your-server.com/invoice.pdf') # binary String
puts html_bytes.bytesize

Write to a stream

require 'pdfcrowd'

client = Pdfcrowd::PdfToHtmlClient.new('demo', 'demo')

File.open('invoice.html', 'wb') do |output_stream|
  client.convertUrlToStream(
    'https://your-server.com/invoice.pdf', output_stream
  )
end

Convert raw PDF bytes

Read logo.pdf as binary data. In an application, pass the bytes you already hold in memory instead.

Save to a file

require 'pdfcrowd'

client = Pdfcrowd::PdfToHtmlClient.new('demo', 'demo')

pdf_data_1 = File.binread('logo.pdf') # binary String
client.convertRawDataToFile(pdf_data_1, 'logo.html')

Keep in memory

require 'pdfcrowd'

client = Pdfcrowd::PdfToHtmlClient.new('demo', 'demo')

pdf_data_1 = File.binread('logo.pdf') # binary String
html_bytes = client.convertRawData(pdf_data_1) # binary String
puts html_bytes.bytesize

Write to a stream

require 'pdfcrowd'

client = Pdfcrowd::PdfToHtmlClient.new('demo', 'demo')

File.open('logo.html', 'wb') do |output_stream|
  pdf_data_1 = File.binread('logo.pdf') # binary String
  client.convertRawDataToStream(pdf_data_1, output_stream)
end

Read from an input stream

Open logo.pdf as a binary input stream and save the result to logo.html.

require 'pdfcrowd'

client = Pdfcrowd::PdfToHtmlClient.new('demo', 'demo')

File.open('logo.pdf', 'rb') do |input_stream|
  client.convertStreamToFile(input_stream, 'logo.html')
end

Customize the HTML output

These examples upload report.pdf, a document with text, images, and vector graphics.

Convert selected pages

Convert pages 1 and 3 of report.pdf into excerpt.html.

require 'pdfcrowd'

client = Pdfcrowd::PdfToHtmlClient.new('demo', 'demo')

client.setPrintPageRange('1,3')
client.convertFileToFile('report.pdf', 'excerpt.html')

Export HTML with separate assets

Save the HTML, stylesheets, fonts, and images in report.zip. Extract the archive and serve its HTML with the accompanying files, preserving their relative paths.

require 'pdfcrowd'

client = Pdfcrowd::PdfToHtmlClient.new('demo', 'demo')

client.setCssMode('separate')
client.setFontMode('separate')
client.setForceZip(true)
client.setImageMode('separate')
client.convertFileToFile('report.pdf', 'report.zip')

Customize the document preview

Scale pages to 75% and change the background, page spacing, and corners in preview.html. Use !important to override the generated background and margin rules.

require 'pdfcrowd'

client = Pdfcrowd::PdfToHtmlClient.new('demo', 'demo')

client.setCustomCss(
  '#page-container { background: #eaf0f6 !important; } .page { margin: 24px auto !important; border-radius: 8px; }'
)
client.setScaleFactor(75)
client.convertFileToFile('report.pdf', 'preview.html')

Avoid naming conflicts

Prefix generated IDs, CSS classes, and font names with report_ in namespaced.html. This helps avoid naming conflicts when integrating the converted content into another page; adjust the surrounding layout separately.

require 'pdfcrowd'

client = Pdfcrowd::PdfToHtmlClient.new('demo', 'demo')

client.setHtmlNamespace('report_')
client.convertFileToFile('report.pdf', 'namespaced.html')

Reduce image resolution

Render page graphics at 72 DPI instead of the default 144 DPI and save smaller.html. Lower resolution can reduce file size at the cost of image detail; text remains HTML text.

require 'pdfcrowd'

client = Pdfcrowd::PdfToHtmlClient.new('demo', 'demo')

client.setDpi(72)
client.convertFileToFile('report.pdf', 'smaller.html')

Preserve vector graphics with SVG

Use SVG for page graphics in vector.html, preserving vector shapes when zooming. Raster images in the PDF remain raster images within the SVG.

require 'pdfcrowd'

client = Pdfcrowd::PdfToHtmlClient.new('demo', 'demo')

client.setImageFormat('svg')
client.convertFileToFile('report.pdf', 'vector.html')