# twig-renderer

> Provides functionality to render twig-templates to HTML or to PDF using Puppeteer.

Latest version **1.0.7** (published 2022-06-08) · ISC license · 0 weekly downloads

## Install

```sh
npm install twig-renderer
pnpm add twig-renderer
yarn add twig-renderer
bun add twig-renderer
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.7 |
| Published | 2022-06-08 |
| First published | 2021-11-04 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 4.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | grongworks |
| Maintainers | grongworks |
| Keywords | twig, render, html, pdf, puppeteer, grongworks, renderer, fancy |

## Links

- npm: https://www.npmjs.com/package/twig-renderer
- Repository: https://github.com/grongworks/twig-renderer
- Homepage: https://github.com/grongworks/twig-renderer#readme
- Issues: https://github.com/grongworks/twig-renderer/issues
- npm.io page: https://npm.io/package/twig-renderer

## Dependencies (2)

- [twig](https://npm.io/package/twig.md) ^1.15.4
- [puppeteer](https://npm.io/package/puppeteer.md) ^14.3.0

## Alternatives

- [@cantoo/pdf-lib](https://npm.io/package/@cantoo/pdf-lib.md) — 297.9K weekly downloads
- [datatables.net-buttons](https://npm.io/package/datatables.net-buttons.md) — 200.1K weekly downloads
- [@ckeditor/ckeditor5-export-pdf](https://npm.io/package/@ckeditor/ckeditor5-export-pdf.md) — 167.0K weekly downloads
- [scanbot-web-sdk](https://npm.io/package/scanbot-web-sdk.md) — 15.0K weekly downloads
- [@syncfusion/ej2-angular-pdfviewer](https://npm.io/package/@syncfusion/ej2-angular-pdfviewer.md) — 8.8K weekly downloads

## Recent versions

- 1.0.7 (latest) — 2022-06-08
- 1.0.4 — 2021-11-04
- 1.0.3 — 2021-11-04
- 1.0.2 — 2021-11-04
- 1.0.1 — 2021-11-04
- 0.0.1 — 2021-11-04
- 2.0.0 — 2021-11-04
- 0.1.0 — 2021-11-04
- 0.0.6 — 2021-11-04
- 0.0.5 — 2021-11-04
- 0.0.4 — 2021-11-04
- 0.0.3 — 2021-11-04

## README

# twig-renderer
This package provides the possibility to convert twig template to HTML. A special feature is the integration of Puppeteer, so that via this package can also be converted directly into PDF. Currently only the DIN A4 format is supported.

### Conversion to HTML
```javascript
const TwigRenderer = require("twig-renderer");

const twigRenderer = new TwigRenderer();
        
const html = await twigRenderer
    .render("./path/to/template", { a: 1, b: 2, c: "Any other data!"})
    .then(result => result.toHtml());
```

### Conversion to PDF-Buffer
```javascript
const TwigRenderer = require("twig-renderer");

const twigRenderer = new TwigRenderer();

const pdfBuffer = await twigRenderer
    .render("./path/to/template", { a: 1, b: 2, c: "Any other data!"})
    .then(result => result.toPdf());
```

---
_Source: https://npm.io/package/twig-renderer · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._