Skip to content

Commit

Permalink
update URLs and information about downloads
Browse files Browse the repository at this point in the history
Most of the issues mentioned were applicable to earlier versions,
which are not applicable to the 0.12.x series.
  • Loading branch information
ashkulz committed Jan 26, 2015
1 parent b609faf commit 83b60cb
Showing 1 changed file with 4 additions and 14 deletions.
18 changes: 4 additions & 14 deletions readme.md
@@ -1,7 +1,7 @@
node-wkhtmltopdf
================

A Node.js wrapper for the [wkhtmltopdf](http://code.google.com/p/wkhtmltopdf/) command line tool. As the name implies,
A Node.js wrapper for the [wkhtmltopdf](http://wkhtmltopdf.org/) command line tool. As the name implies,
it converts HTML documents to PDFs using WebKit.

## Usage
Expand Down Expand Up @@ -30,7 +30,7 @@ wkhtmltopdf('http://google.com/', 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](http://madalgo.au.dk/~jakobt/wkhtmltoxdoc/wkhtmltopdf_0.10.0_rc2-doc.html) available to
There are [many options](http://wkhtmltopdf.org/docs.html) 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.

Expand All @@ -40,18 +40,8 @@ a stream.
## Installation

First, you need to install the wkhtmltopdf command line tool on your system. The easiest way to do this is to
[download](http://code.google.com/p/wkhtmltopdf/downloads/list) a prebuilt version for your system. There are
various platform specific issues to worry about. I've found that the 0.11 version of wkhtmltopdf produces PDFs
without selectable text or clickable links on OS X, and some versions require an X server and others do not.

From my experimentation, the best versions are as follows:

* On OS X, I use [version 0.10](http://code.google.com/p/wkhtmltopdf/downloads/detail?name=wkhtmltopdf-OSX-0.10.0_rc2-static.tar.bz2&can=2&q=).
* On Ubuntu, I use [version 0.9.9](http://code.google.com/p/wkhtmltopdf/downloads/list) 32 or 64 bit from that page. Don't try to use
the version installed via `apt-get` because it is missing features and requires and X server. Follow
[this guide](http://wingdspur.com/2012/12/installing-wkhtmltopdf-on-ubuntu/) to make sure you have all the necessary dependencies.

Although those versions are somewhat old, they have worked the best for me.
[download](http://wkhtmltopdf.org/downloads.html#stable) 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`:

Expand Down

0 comments on commit 83b60cb

Please sign in to comment.