❤
npm
Sign UpSign In

pdf-generator-service

0.2.0 • Public • Published

Express PDF Generator Service

Build Docker Build Coverage Status

A simple express service that generates a pdf based on the submitted HTML using Chromium and Puppeteer.

Getting started

Running locally

## build 
yarn install
yarn 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.

POST /generate

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 }} &copy; {{{ 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:

  1. 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.
  2. TOCs will always appear or be rendered on the first pages of your document.
<html>
<body>
<div class="print-toc">
<h1>Table of contents</h1>
{{#each _toc}}
<a style="display: flex; margin-bottom: 6px; text-decoration: none; color: inherit" href="{{ this.href }}">
    <div>{{ this.title }}</div>
    <div style="margin: 0 4px; flex: 1; border-bottom: 2px dotted black"></div>
    <div>{{ this.page }}</div>
</a>
{{/each}}
</div>
<!-- place your document markup content here and all heading tags will be used to create TOCs -->
</body>
</html>

Readme

Keywords

none

Package Sidebar

Install

npm i pdf-generator-service

Repository

github.com/isneezy/pdf-generator-service

Homepage

github.com/isneezy/pdf-generator-service

Weekly Downloads

0

Version

0.2.0

License

MIT

Unpacked Size

53.1 kB

Total Files

34

Last publish

Collaborators

  • isneezy
Try on RunKit
Report malware