Skip to content


Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
A wrapper for the wkhtmltopdf HTML to PDF converter using WebKit
branch: master

Merge pull request #35 from ashkulz/update-download-info

update URLs and information about downloads
latest commit 409fb86ce2
Devon Govett authored
Failed to load latest commit information.
index.js Better error handling. Fixes #18 and #19.
package.json v0.1.5 update URLs and information about downloads


A Node.js wrapper for the wkhtmltopdf command line tool. As the name implies, it converts HTML documents to PDFs using WebKit.


var wkhtmltopdf = require('wkhtmltopdf');

// URL
wkhtmltopdf('', { pageSize: 'letter' })

wkhtmltopdf('<h1>Test</h1><p>Hello world</p>')

// output to a file directly
wkhtmltopdf('', { output: 'out.pdf' });

// Optional callback
wkhtmltopdf('', { pageSize: 'letter' }, function (code, signal) {
wkhtmltopdf('', function (code, signal) {

wkhtmltopdf is just a function, which you call with either a URL or an inline HTML string, and it returns a stream that you can read from or pipe to wherever you like (e.g. a file, or an HTTP response).

There are many options available to wkhtmltopdf. All of the command line options are supported as documented on the page linked to above. The options are camelCased instead-of-dashed as in the command line tool.

There is also an output option that can be used to write the output directly to a filename, instead of returning a stream.


First, you need to install the wkhtmltopdf command line tool on your system. The easiest way to do this is to download a prebuilt version for your system. Don't try to use the packages provided by your distribution as they may not be using a patched Qt and have missing features.

Finally, to install the node module, use npm:

npm install wkhtmltopdf

Be sure wkhtmltopdf is in your PATH when you're done installing. If you don't want to do this for some reason, you can change the wkhtmltopdf.command property to the path to the wkhtmltopdf command line tool.



Something went wrong with that request. Please try again.