Express PDF Generator Service
A simple express service that generates a pdf based on the submitted HTML using Chromium and Puppeteer.
Getting started
Running locally
## build yarn installyarn build## Running the server node ./dist/src/index.js## Or simply yarn start
Running with docker
docker run --rm -p 3000:3000 --name=service isneezy/pdf-generator
Check our docker hub repository for available tags
API
The webserver started by express.js has one JSON endpoint to generate PDFs.
/generate
POST Will generate a PDF based on the given payload
data and returns the pdf file as a stream
{ "content": "", // required - HTML string/handlebars template to be converted to PDF, "context": {}, // object with the data to be passed to handlebars template engine "orientation": "portrait", // optional - possible values ["portrait", "landscape"] "format": "A4", // optional - possible values ["Letter", "Legal", "Tabloid", "Ledger", "A0", "A1", "A2", "A3", "A4", "A5", "A6"] "header": "", // optional - HTML template for the print header. See https://github.com/puppeteer/puppeteer/blob/main/docs/api.md#pagepdfoptions "footer": "" // optional - HTML template for the print footer. available context variables date: title, url, pageNumber, totalPages and pageNumber. Note these variables should be used with 3 mustaches ex: {{{ pageNumber }}}}
Example
{ "content": "<h2>Hello from Express PDF Generator Service</h2><p>Writen by {{ author }}</p>", "context": { "author": "Ivan Vilanculo <mail@example.com>" }, "orientation": "portrait", "format": "A5", "footer": "<p>{{ name }} © {{{ date }}}, page {{{ pageNumber }}} of {{{ totalPages }}}</p>"}
Generating table of contents (TOCs)
PDF Generator Service can generate TOCs for your document. All you have to do is simply add the template for your TOCs inside an element with .print-toc
class.
Note:
- This feature highly relies on semantic HTML, which means that all heading tags (h1, h2, h3, h4, h5, and h6) will be used to create your TOCs.
Add
toc-ignore
class to a heading tag if you want to ignore. - TOCs will always appear or be rendered on the first pages of your document.
Table of contents{{#each _toc}} {{ this.title }} {{ this.page }}{{/each}}<!-- place your document markup content here and all heading tags will be used to create TOCs -->