Referenz

Command line

Every brevier command and its options.

Auf dieser Seite
brevier --version
brevier --help
brevier <command> --help

render

Renders one template to a PDF or to HTML.

brevier render rechnung.md --data rechnung.json -o rechnung.pdf
Option Meaning
-o, --output The file to write. Required.
--data A JSON file with the data.
--format pdf (default) or html.
--theme A built-in theme: print-base or web.
--style A CSS file. Use it more than once for several files.
--debug Also write the HTML and CSS the engine got, as .debug.html and .debug.css.

The command ends with exit code 1 when something is wrong: broken JSON, a missing field, a schema error, or a missing CSS file. The message says what is wrong and, where it can, on which line.

batch

Renders every template in a folder and its subfolders.

brevier batch templates/

For each .md and .html file, brevier uses a JSON file with the same name as data, if there is one. The output goes next to the template: rechnung.md and rechnung.json give rechnung.pdf.

Option Meaning
--format pdf (default) or html.
--debug As for render.

eject

Writes the HTML that a Markdown template compiles to, next to it.

brevier eject rechnung.md
Option Meaning
--force Replace the HTML file if it exists.

from-code

Writes a schema, a template, a stylesheet and sample data from your classes. See Schema and code.

brevier from-code com.ww.Rechnung --format md
brevier from-code billing.models:Rechnung
Option Meaning
--format html (default) or md.
--theme The theme the template names. Default: print-base.
--classpath Java only: your compiled classes. Default: the current folder.
--force Replace files that exist.