grunt-wkhtmltopdf is now a multi-task
This commit is contained in:
parent
a19e0390f5
commit
b6558233f5
3 changed files with 17 additions and 13 deletions
18
README.md
18
README.md
|
@ -1,6 +1,6 @@
|
||||||
# grunt-wkhtmltopdf
|
# grunt-wkhtmltopdf
|
||||||
|
|
||||||
A simple [Grunt][grunt] task that uses [wkhtmltopdf][wkhtmltopdf] to convert HTML files to PDF.
|
A simple [Grunt][grunt] multitask that uses [wkhtmltopdf][wkhtmltopdf] to convert HTML files to PDF.
|
||||||
Convertion to PDF takes care of `@media print` CSS rules and preserves links to remote web pages.
|
Convertion to PDF takes care of `@media print` CSS rules and preserves links to remote web pages.
|
||||||
|
|
||||||
## Getting Started
|
## Getting Started
|
||||||
|
@ -32,18 +32,24 @@ grunt.loadNpmTasks('grunt-wkhtmltopdf');
|
||||||
[getting_started]: https://github.com/cowboy/grunt/blob/master/docs/getting_started.md
|
[getting_started]: https://github.com/cowboy/grunt/blob/master/docs/getting_started.md
|
||||||
|
|
||||||
## Documentation
|
## Documentation
|
||||||
Simply add the following to your gruntfile:
|
Simply add task definition in your gruntfile. See the folllowing example:
|
||||||
|
|
||||||
```javascript
|
```javascript
|
||||||
//...
|
//...
|
||||||
wkhtmltopdf: {
|
wkhtmltopdf: {
|
||||||
src: 'path/to/some/html/file/*.html',
|
dev: {
|
||||||
dest: 'pdf/output/'
|
src: 'path/to/some/html/file/*.html',
|
||||||
|
dest: 'pdf/output/'
|
||||||
|
},
|
||||||
|
prod: {
|
||||||
|
src: 'path/to/some/html/file/*.html',
|
||||||
|
dest: 'pdf/output/'
|
||||||
|
}
|
||||||
},
|
},
|
||||||
//...
|
//...
|
||||||
```
|
```
|
||||||
|
|
||||||
Then run `grunt wkhtmltopdf` or use it as any other grunt task. Every `html` file in your `path/to/some/html/file/` folder will be turned into a PDF and saved to `pdf/output/` folder.
|
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.
|
||||||
|
|
||||||
## Contributing
|
## 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].
|
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].
|
||||||
|
@ -51,6 +57,8 @@ In lieu of a formal styleguide, take care to maintain the existing coding style.
|
||||||
## Release History
|
## Release History
|
||||||
|
|
||||||
- *v0.1.0*: First Release
|
- *v0.1.0*: First Release
|
||||||
|
- *v0.2.0*: Fixed compatibility with grunt 0.4
|
||||||
|
- *v0.3.0*: grunt-wkhtmltopdf is now a multi-task
|
||||||
|
|
||||||
## License
|
## License
|
||||||
Copyright (c) 2012 Olivier Audard
|
Copyright (c) 2012 Olivier Audard
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
{
|
{
|
||||||
"name": "grunt-wkhtmltopdf",
|
"name": "grunt-wkhtmltopdf",
|
||||||
"description": "Grunt Task that uses wkhtmltopdf to convert HTML files to PDF",
|
"description": "Grunt Task that uses wkhtmltopdf to convert HTML files to PDF",
|
||||||
"version": "0.2.0",
|
"version": "0.3.0",
|
||||||
"homepage": "http://www.dhar.fr/grunt-wkhtmltopdf/",
|
"homepage": "http://www.dhar.fr/grunt-wkhtmltopdf/",
|
||||||
"author": {
|
"author": {
|
||||||
"name": "Olivier Audard",
|
"name": "Olivier Audard",
|
||||||
|
|
|
@ -16,14 +16,10 @@ module.exports = function(grunt) {
|
||||||
// ==========================================================================
|
// ==========================================================================
|
||||||
var helper = require('./lib/wkhtmltopdf-lib').init(grunt);
|
var helper = require('./lib/wkhtmltopdf-lib').init(grunt);
|
||||||
|
|
||||||
grunt.registerTask('wkhtmltopdf', 'Your task description goes here.', function() {
|
grunt.registerMultiTask('wkhtmltopdf', 'Your task description goes here.', function() {
|
||||||
grunt.config.requires('wkhtmltopdf.src');
|
|
||||||
grunt.config.requires('wkhtmltopdf.dest');
|
|
||||||
|
|
||||||
var conf = grunt.config('wkhtmltopdf');
|
var htmlFiles = grunt.file.expandFiles(this.file.src),
|
||||||
|
dest = (this.file.dest && this.file.dest !== '') ? this.file.dest + '/' : '';
|
||||||
var htmlFiles = grunt.file.expandFiles(conf.src),
|
|
||||||
dest = (conf.dest && conf.dest !== '') ? conf.dest + '/' : '';
|
|
||||||
|
|
||||||
grunt.log.writeln("pdf output is: " + dest);
|
grunt.log.writeln("pdf output is: " + dest);
|
||||||
|
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue