Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/deveshrx/node-pdf
Generate PDF files using HTML code
https://github.com/deveshrx/node-pdf
html5 nodejs pdf
Last synced: about 4 hours ago
JSON representation
Generate PDF files using HTML code
- Host: GitHub
- URL: https://github.com/deveshrx/node-pdf
- Owner: DeveshRx
- License: mit
- Created: 2020-12-01T16:40:29.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2020-12-19T07:54:33.000Z (almost 4 years ago)
- Last Synced: 2024-11-14T13:44:52.875Z (5 days ago)
- Topics: html5, nodejs, pdf
- Language: JavaScript
- Homepage:
- Size: 798 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Node-PDF
## Create PDF file from HTML
[![Node version](https://img.shields.io/badge/Version-1.0-blue)](https://www.npmjs.com/package/@deveshrx/node-pdf)
[![Node version](https://img.shields.io/badge/NodeJS%20Version-14+-green)](https://www.npmjs.com/package/@deveshrx/node-pdf)
[![Node version](https://img.shields.io/badge/Developed%20by-Devesh%20Chaudhari-blueviolet)](https://github.com/DeveshRx)Node-PDF can convert html code into pdf file. Node-PDF is based on puppeteer to render html code and create pdf file.
### Install
NodeJS Version 14 & above is supported.
1) Install [NodeJS from Official Website ](https://nodejs.org/en/)2) Install `node-pdf` using npm package manager:
```javascript
npm i @deveshrx/node-pdf
```### Usage
Simple:
`var pdf = await nodepdf.GeneratePDF(,);`Advance:
`await nodepdf.CreatePDF( , , ,); `
`` place your html code into string variable. static html page is recommended for best performance.
`` can be `null` if you wish to save pdf file in parent directory.
`` optional puppeteer Launch Options but can be `null`### Example 1
Create PDF File
```javascript
async function generatePDF(){var html="Hello PDF Generated !!";
var pdf;
var options=null;
// Or var options={headless:false}; // puppeteer Launch Options for advance userspdf= await nodepdf.GeneratePDF(html,options);
//PDF has been generated and now you can whatever you want with "pdf" variablevar pdf_file_name="document.pdf";
fs.writeFile(pdf_file_name, pdf, function (err) {
if (err) return console.log(err);
console.log('PDF Generated');
});}
```### Example 2
Creating PDF File & save it to specific directory```javascript
var nodepdf = require("@deveshrx/node-pdf");async function createPDF(){
var html="Hello PDF !!";
var pdf_file_name="document.pdf";
var folder="my_docs"; // or var folder=null;
var options=null;
// Or var options={headless:false}; // puppeteer Launch Options for advance usersawait nodepdf.CreatePDF(html, pdf_file_name, folder,options);
}
```