Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/redpelicans/jade-pdf-redline
Node module that converts jade files to PDFs.
https://github.com/redpelicans/jade-pdf-redline
Last synced: 7 days ago
JSON representation
Node module that converts jade files to PDFs.
- Host: GitHub
- URL: https://github.com/redpelicans/jade-pdf-redline
- Owner: redpelicans
- License: mit
- Created: 2014-01-28T15:54:24.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2016-04-11T08:57:50.000Z (over 8 years ago)
- Last Synced: 2024-09-17T22:34:48.042Z (16 days ago)
- Language: JavaScript
- Homepage: https://npmjs.org/package/jade-pdf-redline
- Size: 78.1 KB
- Stars: 4
- Watchers: 4
- Forks: 5
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
jade-pdf-redline [](https://travis-ci.org/redpelicans/jade-pdf-redline) [](https://david-dm.org/redpelicans/jade-pdf-redline) [](https://coveralls.io/r/redpelicans/jade-pdf-redline?branch=master)
===
Node module that converts jade files to PDFs.
> https://npmjs.org/package/jade-pdf-redline
## Getting started
npm install jade-pdf-redline
## Usage
```javascript
var jadepdf = require('jade-pdf-redline')
, fs = require('fs');
fs.createReadStream('path/to/template.jade')
.pipe(jadepdf())
.pipe(fs.createWriteStream('path/to/document.pdf'));
```
## Options
Pass an options object (`jadepdf({/* options */})`) to configure the output.
##### options.phantomPath
Type: `String`
Default value: `Path provided by phantomjs module`
*Path to phantom binary*
##### options.cssPath
Type: `String`
Default value: `../pdf.css`
*Path to custom CSS file*
##### options.paperFormat
Type: `String`
Default value: `A4`
*'A3', 'A4', 'A5', 'Legal', 'Letter' or 'Tabloid'*
##### options.paperOrientation
Type: `String`
Default value: `portrait`
*'portrait' or 'landscape'*
##### options.paperBorder
Type: `String`
Default value: `1cm`
*Supported dimension units are: 'mm', 'cm', 'in', 'px'*
##### options.renderDelay
Type: `Number`
Default value: `1000`
*Delay in ms before rendering the PDF*
##### options.locals
Type: `Object`
Default value: `{}`
*Locals for template*
## CLI interface
### Installation
To use jade-pdf-redline as a standalone program from the terminal run
$ npm install -g jade-pdf-redline
### Usage
```sh
Usage: jade-pdf [options]
Options:
-h, --help output usage information
-V, --version output the version number
Path of the jade file to convert
-p, --phantom-path [path] Path to phantom binary
-s, --css-path [path] Path to custom CSS file
-f, --paper-format [format] 'A3', 'A4', 'A5', 'Legal', 'Letter' or 'Tabloid'
-r, --paper-orientation [orientation] 'portrait' or 'landscape'
-b, --paper-border [measurement] Supported dimension units are: 'mm', 'cm', 'in', 'px'
-d, --render-delay [millis] Delay before rendering the PDF
-o, --out [path] Path of where to save the PDF
```
## Running Tests
To run the test suite, first invoke the following command within the repo, installing the development dependencies:
$ npm install
Then run the tests:
$ make test
## License
The MIT License (MIT)
Copyright (c) 2014 redpelicans
Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.