Commit 04ee08f3 authored by Fred Chasen's avatar Fred Chasen

Updated readme

parent 7611dd39
Pipeline #604 skipped
# Vivliostyle Electron PDF Renderer
Render Html to PDFs using Vivliostyle.js and Electron
Render Html to PDFs using [Vivliostyle.js](https://github.com/vivliostyle/vivliostyle.js) and [Electron](https://github.com/bjrmatos/electron-html-to).
## Installation
### From NPM
```
npm install -g https://gitlab.coko.foundation/fchasen/vivliostyle-electron.git
```
### For development
```
npm install
npm link
```
## Generating a PDF
```
vivliostyle-electron ./path/to/index.html -o result.pdf
```
## Options
```
-h, --help output usage information
-V, --version output the version number
-o, --output [output] Output
-d, --debug Debug
-l, --landscape Landscape printing
-s, --page-size [size] Print to Page Size [size]
-w, --width [size] Print to Page Width [width]
-h --height [size] Print to Page Height [weight]
-m, --page-margin [margin] Print with margin [margin]
```
## Running on Linux
Install Xvfb:
```
sudo apt-get install xvfb
```
Run Xvfb:
```
export DISPLAY=':99.0'
Xvfb :99 -screen 0 1024x768x24 > /dev/null 2>&1 &
```
More details here: https://github.com/bjrmatos/electron-html-to/issues/87
......@@ -7,10 +7,10 @@ var path = require('path');
program
.version('0.0.1')
.arguments('[inputPath]')
.option('-i, --inputs [inputs]', 'Inputs')
// .option('-i, --inputs [inputs]', 'Inputs')
.option('-o, --output [output]', 'Output')
.option('-d, --debug', 'Debug')
.option('-l, --landscape', 'Landscape priting', false)
.option('-l, --landscape', 'Landscape printing', false)
.option('-s, --page-size [size]', 'Print to Page Size [size]')
.option('-w, --width [size]', 'Print to Page Width [width]')
.option('-h --height [size]', 'Print to Page Height [weight]')
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment