# realx

> Create PDF documents using web technologies (PDF/SCSS)

Latest version **0.0.15** (published 2020-02-21) · ISC license · 0 weekly downloads

## Install

```sh
npm install realx
pnpm add realx
yarn add realx
bun add realx
```

Provides the commands `realx`, `pdf2gif`, `pretty-pdf-thumbnail`.

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.15 |
| Published | 2020-02-21 |
| First published | 2019-10-28 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 21 |
| Unpacked size | 227.3 KB |
| Known vulnerabilities | 0 (+13 in 4 direct dependencies) |
| Install scripts | no |
| Author | thibaut@16pixels.fr |
| Maintainers | thibzzz |

## Links

- npm: https://www.npmjs.com/package/realx
- Homepage: https://github.com/16pixels/realx
- npm.io page: https://npm.io/package/realx

## Dependencies (21)

- [pug](https://npm.io/package/pug.md) ^2.0.3
- [jimp](https://npm.io/package/jimp.md) ^0.5.4
- [katex](https://npm.io/package/katex.md) ^0.10.0-beta
- [colors](https://npm.io/package/colors.md) ^1.3.0
- [cheerio](https://npm.io/package/cheerio.md) ^1.0.0-rc.2
- [deptree](https://npm.io/package/deptree.md) ^1.0.0
- [js-yaml](https://npm.io/package/js-yaml.md) ^3.12.0
- [mermaid](https://npm.io/package/mermaid.md) ^8.0.0-rc.8
- [chokidar](https://npm.io/package/chokidar.md) ^2.0.3
- [filesize](https://npm.io/package/filesize.md) ^3.6.1
- [commander](https://npm.io/package/commander.md) ^2.15.1
- [csvtojson](https://npm.io/package/csvtojson.md) ^2.0.3
- [deepmerge](https://npm.io/package/deepmerge.md) ^4.2.2
- [html2jade](https://npm.io/package/html2jade.md) ^0.8.6
- [node-sass](https://npm.io/package/node-sass.md) ^4.9.0
- [puppeteer](https://npm.io/package/puppeteer.md) ^1.8.0
- [markdown-it](https://npm.io/package/markdown-it.md) ^10.0.0
- [mathjax-node-page](https://npm.io/package/mathjax-node-page.md) ^3.0.1
- [markdown-it-footnote](https://npm.io/package/markdown-it-footnote.md) ^3.0.2
- [jstransformer-highlight](https://npm.io/package/jstransformer-highlight.md) ^2.0.0
- [jstransformer-markdown-it](https://npm.io/package/jstransformer-markdown-it.md) ^2.1.0

## Recent versions

- 0.0.15 (latest) — 2020-02-21
- 0.0.14 — 2020-02-21
- 0.0.13 — 2020-02-21
- 0.0.12 — 2020-02-21
- 0.0.11 — 2020-02-21
- 0.0.10 — 2019-11-12
- 0.0.9 — 2019-11-08
- 0.0.8 — 2019-11-06
- 0.0.7 — 2019-11-06
- 0.0.6 — 2019-11-06
- 0.0.5 — 2019-11-06
- 0.0.4 — 2019-10-29
- 0.0.3 — 2019-10-29
- 0.0.2 — 2019-10-29
- 0.0.1 — 2019-10-28

## README

# Realx

This is a fork from [RelaxedJS](https://github.com/RelaxedJS/ReLaXed/wiki/Command-line-options) to add more features to CLI such as : 
* get locals from URL endpoint
* get locals from file

To have more info type :

```
realx -h
```

The api is the same from forked software, we add two specific methods :

```
-i, --input <path> OR path1,path2,pathN       path(s) of json variables file(s) for pug rendering
-u, --url <url>          url of json endpoint for pug rendering
```

You api response must be formatted as followed : 

```
{ # an object containing any variables you want to inject in your pdf
  "1": "",
  "2": 123,
  "3": true,
  "n": false
}
```

# Changelog (dd/mm/yyyy)

* 12/11/2019 : add ``-d`` command to debug variables from ``locals``, ``input`` and ``url`` parameters so they can be print to console
* 06/11/2019 : added a method to merge variables from ``locals``, ``input`` and ``url`` parameters can now be used simultaneously
* 01/11/2019 : add ``-i``, ``-u`` commands.

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