html-boilerplate-pdf
Node module that converts HTML body documents strings to PDFs.
Using same process and similar options to html-boilerplate-pdf
The PDF looks great because it is styled by HTML5 Boilerplate. What? - Yes! Your HTML is pushed into the HTML5 Boilerplate index.html
. Phantomjs renders the page and saves it to a PDF. You can even customise the style of the PDF by passing an optional path to your CSS and you can pre-process your html file before it is converted to a PDF by passing in a pre-processing function, for templating.
Getting started
npm install html-boilerplate-pdf
Example usage
from
Options
Pass an options object (htmlBoilerplatePDF({/* 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: [module path]/pdf.css
Path to custom CSS file, relative to the current directory
options.highlightCssPath
Type: String
Default value: [module path]/highlight.css
Path to custom highlight CSS file (for code highlighting), relative to the current directory
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.runningsPath
Type: String
Default value: runnings.js
Path to CommonJS module which sets the page header and footer (see runnings.js)
options.renderDelay
Type: Number
Default value: 1000
Delay in millis before rendering the PDF (give HTML and CSS a chance to load)
options.preProcessHtml
Type: Function
Default value: function () { return through() }
A function that returns a through stream that transforms the HTML before it is converted to PDF.
API
from.path(path, opts) / from(path, opts)
Create a readable stream from path
and pipe to html-boilerplate-pdf. path
can be a single path or array of paths.
from.string(string)
Create a readable stream from string
and pipe to html-boilerplate-pdf. string
can be a single string or array of strings.
concat.from.paths(paths, opts)
Create and concatinate readable streams from paths
and pipe to html-boilerplate-pdf.
concat.from.strings(strings, opts)
Create and concatinate readable streams from strings
and pipe to html-boilerplate-pdf.
to.path(path, cb) / to(path, cb)
Create a writeable stream to path
and pipe output from html-boilerplate-pdf to it. path
can be a single path, or array of output paths if you specified an array of inputs. The callback function cb
will be invoked when data has finished being written.
to.buffer(opts, cb)
Create a concat-stream and pipe output from html-boilerplate-pdf to it. The callback function cb
will be invoked when the buffer has been created.
to.string(opts, cb)
Create a concat-stream and pipe output from html-boilerplate-pdf to it. The callback function cb
will be invoked when the string has been created.
More examples
From string to path
var htmlBoilerplatePDF = var md = "foo===\n* bar\n* baz\n\nLorem ipsum dolor sit" outputPath = "/path/to/doc.pdf" from
From multiple paths to multiple paths
var htmlBoilerplatePDF = var htmlDocs = "home.html" "about.html" "contact.html" pdfDocs = mdDocs
Concat from multiple paths to single path
var htmlBoilerplatePDF = var htmlDocs = "chapter1.html" "chapter2.html" "chapter3.html" bookPath = "/path/to/book.pdf" concat
Transform html before conversion
var htmlBoilerplatePDF = split = through = duplexer = { // Split the input stream by lines var splitter = // Replace occurrences of "foo" with "bar" var replacer = splitter return }
CLI interface
Installation
To use html-boilerplate-pdf as a standalone program from the terminal run
npm install -g html-boilerplate-pdf
Usage
Usage: html-boilerplate-pdf [options] <html-file-path> Options: -h, --help output usage information -V, --version output the version number <html-file-path> Path of the html file to convert -p, --phantom-path [path] Path to phantom binary -h, --runnings-path [path] Path to runnings -s, --css-path [path] Path to custom CSS file -z, --highlight-css-path [path] Path to custom highlight-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