From 69a270f60425a7077bdb33af13b4b037d33de4d4 Mon Sep 17 00:00:00 2001 From: Olivier Audard Date: Sun, 22 Feb 2015 11:03:01 +0100 Subject: [PATCH] Updated README --- README.md | 63 +++++++++++++++++++++++++++++++++++--------- tasks/wkhtmltopdf.js | 2 +- 2 files changed, 51 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 3cca3a4..d60efb5 100644 --- a/README.md +++ b/README.md @@ -5,11 +5,11 @@ Convertion to PDF takes care of `@media print` CSS rules and preserves links to ## Getting Started -### Setting up wkhtmltopdf +### Setting up wkhtmltopdf Download and install wkhtmltopdf from the [project page][wkhtmltopdf_dl]. -Make sure `wkhtmltopdf` is accessible from your `PATH` (Try `wkhtmltopdf -V` in your Terminal). +Make sure `wkhtmltopdf` is accessible from your `PATH` (Try `wkhtmltopdf -V` in your Terminal). I'm on Mac OS X, so I created the following symlink to my `/usr/local/bin/` folder: ``` @@ -29,11 +29,6 @@ Then add this line to your project's `grunt.js` gruntfile: grunt.loadNpmTasks('grunt-wkhtmltopdf'); ``` -[wkhtmltopdf]: http://wkhtmltopdf.org/ -[wkhtmltopdf_dl]: http://wkhtmltopdf.org/downloads.html -[grunt]: https://github.com/gruntjs/grunt -[getting_started]: https://github.com/cowboy/grunt/blob/master/docs/getting_started.md - ## Documentation Simply add task definition in your gruntfile. See the folllowing example: @@ -54,19 +49,61 @@ Simply add task definition in your gruntfile. See the folllowing example: Run `grunt wkhtmltopdf` to execute all the targets or `grunt wkhtmltopdf:targetname` to execute a specific target. Every `html` file defined by the `src` parameter will be turned into a PDF and saved to `dest` folder. +### Sending arguments to `wkhtml2pdf` + +Arguments sent via the `args` key in the task definition will be forwarded to `wkhtml2pdf` as follow : + +```javascript + //... + wkhtmltopdf: { + prod: { + src: 'path/to/some/html/file/*.html', + dest: 'pdf/output/', + args: [ + '--dpi', '96', + '--print-media-type', + '--grayscale' + ] + } + }, + //... +``` + +Defining custom arguments will override default ones: + +```javascript +// grunt-wkhtml2pdf default arguments +var args = [ + '--dpi', '96', + '--print-media-type' +] +``` + +See [wkhtml2pdf documentation][wkhtmltopdf_doc] for available options + ## Contributing In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using [grunt][grunt]. ## Release History - - *v0.1.0*: First Release - - *v0.2.0*: Fixed compatibility with grunt 0.4 - - *v0.3.0*: grunt-wkhtmltopdf is now a multi-task - - *v0.4.0*: + - *v0.5.0*: + - Merged #12 (Fix #11) : Added async support + - Merged #9 : Added ability to override the arguments + - *v0.4.0*: - Update project config files to work with Grunt 0.4 - Update wkthmltopdf task to use Grunt 0.4 multi-task API - - Improve predictability of the destination for created PDFs + - Improve predictability of the destination for created PDFs + - *v0.3.0*: grunt-wkhtmltopdf is now a multi-task + - *v0.2.0*: Fixed compatibility with grunt 0.4 + - *v0.1.0*: First Release ## License -Copyright (c) 2012 Olivier Audard +Copyright (c) 2012 Olivier Audard Licensed under the MIT license. + + +[wkhtmltopdf]: http://wkhtmltopdf.org/ +[wkhtmltopdf_dl]: http://wkhtmltopdf.org/downloads.html +[wkhtmltopdf_doc]: http://wkhtmltopdf.org/docs.html +[grunt]: https://github.com/gruntjs/grunt +[getting_started]: https://github.com/cowboy/grunt/blob/master/docs/getting_started.md diff --git a/tasks/wkhtmltopdf.js b/tasks/wkhtmltopdf.js index faf1580..375915d 100644 --- a/tasks/wkhtmltopdf.js +++ b/tasks/wkhtmltopdf.js @@ -60,7 +60,7 @@ module.exports = function(grunt) { // default args var args = [ '--dpi', '96', // workarround to wkhtmltopdf letter-spacing bug (see http://code.google.com/p/wkhtmltopdf/issues/detail?id=72) - '--print-media-type', // Use @print media type + '--print-media-type' // Use @print media type ]; // overrides the args