grunt-pdf-imagepack

grunt-pdf-imagepack

Generate image packed pdf

This plugin depends pdfkit.

Getting Started

This plugin requires Grunt.

If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

npm install grunt-pdf-imagepack --save-dev

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

grunt.loadNpmTasks('pdf-imagepack');

The "pdf_imagepack" task

Overview

In your project's Gruntfile, add a section named pdf_imagepack to the data object passed into grunt.initConfig().

grunt.initConfig({
  pdf_imagepack: {
    options: {
      pdf:{
        // Task-specific options (for pdfkit) go here.
      }
    },
    files: {
      // Target-specific file lists and/or options go here.
    },
  },
})

Options

options.pdf

Type: Object

This option through to pdfkit object.

Usage Examples

Default Options

In this example, the source file is packed to pdf file.

grunt.initConfig({
  pdf_imagepack: {
    defaults: {
      files: {
        'tmp/sample.pdf': ['some/images/*']
      }
    }
  }
})

Custom Options

If you want specify the pdf size. You can use options.pdf

grunt.initConfig({
  pdf_imagepack: {
    with_pdf_option: {
      options : {
        pdf : {
          size : "B5"
        }
      },
      files: {
        'tmp/sample.pdf': ['some/images/*']
      }
    }
  }
})

Release History

(Nothing yet)

License

Copyright (c) 2014 suisho. Licensed under the MIT license.