https://github.com/fireblinkltd/fbl-plugins-html-to-pdf

FBL plugin to generate PDF file based on HTML template
https://github.com/fireblinkltd/fbl-plugins-html-to-pdf

Last synced: about 2 months ago
JSON representation

FBL plugin to generate PDF file based on HTML template

• Host: GitHub
• URL: https://github.com/fireblinkltd/fbl-plugins-html-to-pdf
• Owner: FireBlinkLTD
• License: mit
• Created: 2019-05-27T13:46:51.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-03-26T21:28:48.000Z (10 months ago)
• Last Synced: 2024-04-27T02:43:43.019Z (9 months ago)
• Language: TypeScript
• Size: 1.58 MB
• Stars: 0
• Watchers: 2
• Forks: 1
• Open Issues: 15
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# FBL Plugins: HTML to PDF

Allows to convert any HTML document into PDF file inside [fbl](https://fbl.fireblink.com) flow.

[![Tests](https://github.com/FireBlinkLTD/fbl-plugins-html-to-pdf/workflows/Tests/badge.svg)](https://github.com/FireBlinkLTD/fbl-plugins-html-to-pdf/actions?query=workflow%3ATests)

[![Known Vulnerabilities](https://snyk.io/test/github/FireBlinkLTD/fbl-plugins-html-to-pdf/badge.svg)](https://snyk.io/test/github/FireBlinkLTD/fbl-plugins-html-to-pdf)

[![codecov](https://codecov.io/gh/FireBlinkLTD/fbl-plugins-html-to-pdf/branch/master/graph/badge.svg)](https://codecov.io/gh/FireBlinkLTD/fbl-plugins-html-to-pdf)

[![Total alerts](https://img.shields.io/lgtm/alerts/g/FireBlinkLTD/fbl-plugins-html-to-pdf.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/FireBlinkLTD/fbl-plugins-html-to-pdf/alerts/)

[![Language grade: JavaScript](https://img.shields.io/lgtm/grade/javascript/g/FireBlinkLTD/fbl-plugins-html-to-pdf.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/FireBlinkLTD/fbl-plugins-html-to-pdf/context:javascript)

## Integration

There are multiple ways how plugin can be integrated into your flow.

### package.json

This is the most recommended way. Create `package.json` next to your flow file with following content:

```json

{

  "name": "flow-name",

  "version": "1.0.0",

  "description": "",

  "scripts": {

    "fbl": "fbl"

  },

  "license": "UNLICENSED",

  "dependencies": {

    "@fbl-plugins/html-to-pdf": "1.0.2",

    "fbl": "1.9.2"

  }

}

```

Then you can install dependencies as any other node module `yarn install` depending on the package manager of your choice.

After that you can use `yarn fbl ` to execute your flow or even register a custom script inside "scripts".

### Global installation

`npm i -g @fbl-plugins/html-to-pdf`

### Register plugin to be accessible by fbl

- via cli: `fbl -p @fbl-plugins/html-to-pdf `

- via flow:

```yaml

requires:

  fbl: '>=1.9.2'

  plugins:

    '@fbl-plugins/html-to-pdf': '>=1.0.2'

pipeline:

  # your flow goes here

```

## Documentation

Read more [here](docs/README.md).