https://github.com/alextiley/convert-html-to-pdf
Convert HTML to PDF
https://github.com/alextiley/convert-html-to-pdf
Last synced: 11 months ago
JSON representation
Convert HTML to PDF
- Host: GitHub
- URL: https://github.com/alextiley/convert-html-to-pdf
- Owner: alextiley
- Created: 2019-08-04T10:15:08.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2023-01-04T06:14:07.000Z (over 3 years ago)
- Last Synced: 2024-12-06T21:42:51.267Z (over 1 year ago)
- Language: TypeScript
- Size: 1.25 MB
- Stars: 12
- Watchers: 3
- Forks: 6
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# html-to-pdf
A library for converting HTML with CSS to PDF.
### Dependencies
This library uses Puppeteer to generate PDF's.
Some systems may work out of the box, others may not. To allow Puppeteer to spin up correctly, you may need to install some additional system dependencies.
For pointers on how to make puppeteer work in your environment, see https://github.com/GoogleChrome/puppeteer/blob/master/docs/troubleshooting.md#running-puppeteer-in-docker
### Basic usage
This library exports a method allowing conversion of HTML to PDF. When invoked with a valid HTML template as the first argument, a Buffer is returned containing a PDF document, along with the `application/pdf` mime type. The second argument is a configuration object, allowing customisation of Puppeteer, or the output of the PDF.
```javascript
const HTMLToPDF = require('convert-html-to-pdf').default;
const htmlToPDF = new HTMLToPDF(`
Hello world
`);
htmlToPDF.convert()
.then((buffer) => {
// do something with the PDF file buffer
})
.catch((err) => {
// do something on error
});
```
Or, if using async await:
```javascript
const HTMLToPDF = require('convert-html-to-pdf').default;
const getPDF = async () => {
const htmlToPDF = new HTMLToPDF(`
Hello world
`);
try {
const pdf = await htmlToPDF.convert();
// do something with the PDF file buffer
} catch (err) {
// do something on error
}
};
```
For PDF's that should contain imagery or web fonts, it's recommended to base 64 encode any assets and embed within the markup using a data URI. This will yield faster results. If you'd rather request assets over HTTP, you can do this by enabling the `waitForNetworkIdle` configuration option.
##### Example of an asset encoded as base 64
```javascript
const HTMLToPDF = require('convert-html-to-pdf').default;
const htmlToPDF = new HTMLToPDF(`
