Erste Schritte
Einführung
brevier macht aus einer Vorlage und Ihren Daten ein fertiges PDF. Diese Seite zeigt die Idee und die Schritte dazwischen.
Auf dieser Seite
Was brevier macht
brevier erzeugt Geschäftsdokumente: Rechnungen, Briefe, Verträge und Berichte. Sie geben brevier zwei Dinge:
- eine Vorlage in HTML oder Markdown, gestaltet mit CSS
- Ihre Daten als JSON
brevier setzt die Daten in die Vorlage ein und druckt ein PDF.
brevier render rechnung.html --data rechnung.json -o rechnung.pdfDie Vorlage ist eine normale Web-Datei. Sie schreiben sie in Ihrem Editor, legen sie in Git ab und prüfen sie im Review wie Code. Es gibt kein Zeichenprogramm und kein eigenes Dateiformat.
Wie ein Dokument entsteht
Jeder Aufruf durchläuft dieselben fünf Schritte.
| Schritt | Was passiert |
|---|---|
| 1. Übersetzen | Eine Markdown-Vorlage wird zu HTML. Eine HTML-Vorlage bleibt, wie sie ist. |
| 2. Prüfen | Liegt ein Schema neben der Vorlage, prüft brevier Vorlage und Daten dagegen. |
| 3. Einsetzen | Jedes {{ feld }} bekommt seinen Wert aus den Daten. Schleifen und Bedingungen laufen. |
| 4. Vorbereiten | brevier ergänzt deutsche Silbentrennung und geschützte Leerzeichen. |
| 5. Drucken | Die Engine setzt die Seiten und schreibt das PDF. |
Schritt 2 bricht ab, wenn etwas nicht passt. Sie sehen den Fehler im Terminal oder im Build und nicht erst auf dem Papier beim Kunden.
Hängen Sie --debug an einen Aufruf. brevier legt dann genau das HTML und
CSS, das die Engine bekommen hat, neben das PDF. Das HTML können Sie im
Browser öffnen.
Für wen es ist
brevier ist für Entwickler, die Dokumente aus ihrem eigenen Code drucken. Sie kennen HTML und CSS und wollen für Ihre Dokumente dasselbe Review, dieselben Tests und dieselbe CI wie für den Rest Ihrer Software.
Wie es weitergeht
- Installation richtet den Befehl
brevierein. - Ihr erstes Dokument erzeugt eine Rechnung in drei Schritten.