Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jorgenevens/crpdf
Print HTML to PDF using puppeteer with a wkhtmltopdf compatible CLI
https://github.com/jorgenevens/crpdf
pdf printpdf puppeteer wkhtmltopdf
Last synced: 2 months ago
JSON representation
Print HTML to PDF using puppeteer with a wkhtmltopdf compatible CLI
- Host: GitHub
- URL: https://github.com/jorgenevens/crpdf
- Owner: JorgenEvens
- License: mit
- Created: 2018-03-04T15:22:52.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2019-10-07T20:33:24.000Z (about 5 years ago)
- Last Synced: 2024-04-15T02:45:09.989Z (9 months ago)
- Topics: pdf, printpdf, puppeteer, wkhtmltopdf
- Language: JavaScript
- Homepage: https://crpdf.evens.eu
- Size: 141 KB
- Stars: 8
- Watchers: 3
- Forks: 2
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# crPDF
Print HTML to PDF using [Puppeteer](https://github.com/GoogleChrome/puppeteer) with a [wkhtmltopdf](https://wkhtmltopdf.org/) compatible CLI.
## Motivation
While creating print versions of HTML on modern browsers is not fun, it is not an impossible feat. Getting HTML to PDF tools to render correctly on the other hand is very challenging. That is why this project leverages [Puppeteer](https://github.com/GoogleChrome/puppeteer) (Headless Chrome/Chromium) to generate PDFs from HTML. If you can get your layout to work using print preview on Chrome you will be good to go using this library.
Many of us have relied on wkhtmltopdf over the years, and it has great library support. To make transitioning as easy as possible crPDF matches the CLI options which allows you to use crPDF as a drop-in replacement.
## Installation
### Using NPM
Use NPM to install the latest version of `crPDF`, this package will install both a `crpdf` and `wkhtmltopdf` binary.
```sh
npm install -g crpdf
```
### Manual
Download a binary for your platform from the [releases page](https://github.com/JorgenEvens/crPDF/releases) and place it in your `$PATH`.
```sh
curl -L -o crpdf
chmod +x crpdf
cp crpdf /usr/local/bin/crpdf
# Optionally set up an alias for wkhtmltopdf
ln -s /usr/local/bin/crpdf /usr/local/bin/wkhtmltopdf
```
## Usage
The CLI interface is meant to be compatible with the `wkhtmltopdf` binary such that it can be used as a drop-in replacement for existing libraries using [wkhtmltopdf](https://wkhtmltopdf.org/).
Below is a list of options currently implemented by this project.
```sh
crpdf --help
Usage: cli [options] [input] [output]
Options:
-V, --version output the version number
-B, --margin-bottom Set the page bottom margin
-L, --margin-left Set the page left margin (default 10mm)
-R, --margin-right Set the page right margin (default 10mm)
-T, --margin-top Set the page top margin
-O, --orientation Set orientation to Landscape or Portrait (default Portrait)
-s, --page-size Set paper size to: A4, Letter, etc. (default A4)
--page-height Page height
--page-width Page width
--page-ranges Page ranges to print, e.g., "1-5, 8, 11-13" (default all)
--background Do print background
--no-background Do not print background
-h, --help output usage information
```
Note, `--page-ranges` is not available in `wkhtmltopdf` and thus not backwards compatible.
## Contributing
I really appreciate any contribution you would like to make, so don't hesitate to report an issue or submit pull requests.
## About me
Hi, my name is [Jorgen Evens](https://jorgen.evens.eu). By day I built things (mainly in PHP and JavaScript) for [Ambassify](https://ambassify.com) and by night I tinker around with these kinds of projects.