# grunt-pdf-imagepack

> Generate image packed pdf

Latest version **0.0.5** (published 2015-07-01) · 0 weekly downloads

## Install

```sh
npm install grunt-pdf-imagepack
pnpm add grunt-pdf-imagepack
yarn add grunt-pdf-imagepack
bun add grunt-pdf-imagepack
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.5 |
| Published | 2015-07-01 |
| First published | 2014-05-18 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 0.8.0 |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | suisho |
| Maintainers | suisho |
| Keywords | gruntplugin, image, pdf |

## Links

- npm: https://www.npmjs.com/package/grunt-pdf-imagepack
- npm.io page: https://npm.io/package/grunt-pdf-imagepack

## Dependencies (1)

- [pdf-image-pack](https://npm.io/package/pdf-image-pack.md) ~0.0.0

## Alternatives

- [@cantoo/pdf-lib](https://npm.io/package/@cantoo/pdf-lib.md) — 297.9K weekly downloads
- [datatables.net-buttons](https://npm.io/package/datatables.net-buttons.md) — 200.1K weekly downloads
- [@ckeditor/ckeditor5-export-pdf](https://npm.io/package/@ckeditor/ckeditor5-export-pdf.md) — 167.0K weekly downloads
- [scanbot-web-sdk](https://npm.io/package/scanbot-web-sdk.md) — 15.0K weekly downloads
- [@syncfusion/ej2-angular-pdfviewer](https://npm.io/package/@syncfusion/ej2-angular-pdfviewer.md) — 8.8K weekly downloads

## Recent versions

- 0.0.5 (latest) — 2015-07-01
- 0.0.4 — 2014-05-18

## README

# grunt-pdf-imagepack

> Generate image packed pdf

This plugin depends [pdfkit](http://pdfkit.org/).

## Getting Started
This plugin requires Grunt.

If you haven't used [Grunt](http://gruntjs.com/) before, be sure to check out the [Getting Started](http://gruntjs.com/getting-started) guide, as it explains how to create a [Gruntfile](http://gruntjs.com/sample-gruntfile) as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

```shell
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:

```js
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()`.

```js
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.

```js
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`

```js
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.

---
_Source: https://npm.io/package/grunt-pdf-imagepack · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._