https://github.com/isneezy/pdf-generator-service
A simple express service that generates a pdf based on the submitted HTML
https://github.com/isneezy/pdf-generator-service
docker html-to-pdf pdf rest-api toc-generator
Last synced: 2 months ago
JSON representation
A simple express service that generates a pdf based on the submitted HTML
- Host: GitHub
- URL: https://github.com/isneezy/pdf-generator-service
- Owner: isneezy
- License: mit
- Created: 2020-09-09T20:38:27.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-04-14T18:59:00.000Z (almost 3 years ago)
- Last Synced: 2025-11-23T08:04:21.550Z (4 months ago)
- Topics: docker, html-to-pdf, pdf, rest-api, toc-generator
- Language: TypeScript
- Homepage:
- Size: 1.15 MB
- Stars: 43
- Watchers: 2
- Forks: 10
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Express PDF Generator Service
[](https://github.com/isneezy/pdf-generator-service/tree/next)
[](https://quay.io/repository/isneezy/pdf-generator-service)
[](https://coveralls.io/github/isneezy/pdf-generator-service?branch=master)
> ☝️ A next version with better performance and features is coming soon.
> To try it out, check its documentation in the
> [next branch](https://github.com/isneezy/pdf-generator-service/tree/next).
A simple express service that generates a pdf based on the submitted HTML using Chromium and Puppeteer.
## Getting started
#### Running locally
```bash
## 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=pdf-generator quay.io/isneezy/pdf-generator-service
```
Check our [docker repository](https://quay.io/repository/isneezy/pdf-generator-service?tab=tags) 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
```json5
{
"goto": "", // optional - URL to the HTML content/handlebars template to be converted to PDF. This option overrides the content when present.
"content": "", // required when goto is not present - 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
```json5
{
"content": "
Hello from Express PDF Generator Service
Writen by {{ author }}
",
"context": { "author": "Ivan Vilanculo " },
"orientation": "portrait",
"format": "A5",
"footer": "{{ name }} © {{{ date }}}, page {{{ pageNumber }}} of {{{ totalPages }}}
"
}
```
### 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.
```handlebars
```