https://github.com/traviscooper/node-wkhtml

Convert html to PDF or PNG format using the webkit rendering engine, and qt.
https://github.com/traviscooper/node-wkhtml

Last synced: 3 months ago
JSON representation

Convert html to PDF or PNG format using the webkit rendering engine, and qt.

• Host: GitHub
• URL: https://github.com/traviscooper/node-wkhtml
• Owner: traviscooper
• Created: 2011-07-13T23:40:38.000Z (over 13 years ago)
• Default Branch: master
• Last Pushed: 2024-02-23T13:28:12.000Z (10 months ago)
• Last Synced: 2024-08-11T15:00:19.864Z (4 months ago)
• Language: JavaScript
• Homepage:
• Size: 3.27 MB
• Stars: 104
• Watchers: 6
• Forks: 17
• Open Issues: 8
• Metadata Files:
  • Readme: Readme.md

Awesome Lists containing this project

README

        
# node-wkhtml

Wrapper for the **wkhtmltopdf** and **wkhtmltoimage** shell utilities. Converts html to pdf or image format using the webkit rendering engine, and qt.

See: https://github.com/antialize/wkhtmltopdf

## Usage

Generate a PDF of node doc and pipe to response.

    var wkhtml = require('node-wkhtml');

    wkhtml

        .spawn('pdf', 'http://nodejs.org/api/all.html')

        .stdout.pipe(response);

      

Generate a PDF of node doc and write it to the file system.

    var wkhtml = require('../index.js'),

        createWriteStream = require('fs').createWriteStream;

        

    wkhtml

      .spawn('pdf', 'http://nodejs.org/api/all.html')

      .stdout.pipe(createWriteStream('node_doc.pdf'));

Generate a PDF from a string and pipe it to the response

    

    var wkhtml = require('node-wkhtml')

    

    var pdf = wkhtml.spawn('pdf');

    pdf.stdout.pipe(response);

    pdf.stdin.end('
Hello World
');


See http://madalgo.au.dk/~jakobt/wkhtmltoxdoc/wkhtmltopdf_0.10.0_rc2-doc.html.

## wkhtmltopdf & wkhtmltoimage Installation

Download the appropriate utility from http://code.google.com/p/wkhtmltopdf/downloads/list. Compilation instructions can be found here: http://madalgo.au.dk/~jakobt/wkhtmltoxdoc/wkhtmltopdf_0.10.0_rc2-doc.html

**The pdf and image features are in separate utilities**. You will need to download the utility for the feature(s) you plan on using.

## node-wkhtml Installation

    npm install node-wkhtml

    

## Examples

See the /examples directory.