Skip to content
This repository was archived by the owner on Apr 29, 2025. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions .all-contributorsrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
{
"files": [
"README.md"
],
"imageSize": 100,
"commit": false,
"contributors": [],
"contributorsPerLine": 7,
"projectName": "HTML-PDF",
"projectOwner": "MyUnisoft",
"repoType": "github",
"repoHost": "https://github.com",
"skipCi": true
}
60 changes: 49 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,33 @@
# HTMLToPDF
Node lib to converts HTML with property binding or url to PDF files

## Installation
```$ npm install @myunisoft/html-to-pdf```

## Unit Test
- Jest
- Coverage : 100%

## Usage
<p align="center"><h1 align="center">
HTML-PDF
</h1>

<p align="center">
Node lib to converts HTML with property binding or url to PDF files.
</p>

<p align="center">
<a href="https://github.com/MyUnisoft/HTML-PDF"><img src="https://img.shields.io/github/package-json/v/MyUnisoft/HTML-PDF?style=flat-square" alt="npm version"></a>
<a href="https://github.com/MyUnisoft/HTML-PDF"><img src="https://img.shields.io/github/license/MyUnisoft/HTML-PDF?style=flat-square" alt="license"></a>
<a href="https://github.com/MyUnisoft/HTML-PDF"><img src="https://img.shields.io/github/languages/code-size/MyUnisoft/HTML-PDF?style=flat-square" alt="size"></a>
</p>

## 🚧 Requirements
---
- [Node.js](https://nodejs.org/en/) version 14 or higher

## 🚀 Getting Started
---
This package is available in the Node Package Repository and can be easily installed with [npm](https://doc.npmjs.com/getting-started/what-is-npm) or [yarn](https://yarnpkg.com)

```bash
$ npm i @myunisoft/html-to-pdf
# or
$ yarn add @myunisoft/html-to-pdf
```

## 📚 Usage
---
```js
async function main() {
const browser = await initBrowser();
Expand All @@ -28,6 +46,9 @@ async function main() {
main().catch(console.error);
```

## API
---

### initBrowser(options: PuppeteerLaunchOptions): Promise<Browser>

```js
Expand Down Expand Up @@ -70,3 +91,20 @@ async function main() {
}
main().catch(console.error);
```

## Contributors ✨

<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
[![All Contributors](https://img.shields.io/badge/all_contributors-3-orange.svg?style=flat-square)](#contributors-)
<!-- ALL-CONTRIBUTORS-BADGE:END -->

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->

<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->

<!-- ALL-CONTRIBUTORS-LIST:END -->
Loading