documents/README.md
ndsboy 08c39297c4
Some checks are pending
Build PDFs / 🚢 Deploy (push) Waiting to run
docs: update readme
2025-02-23 16:26:32 +00:00

1.5 KiB

Offizielle Dokumente

Hier befinden sich die Typst-Vorlagen der offiziellen Vereinsdokumente des swablab e.V.

Installation

Um aus den Vorlagen Dokumente zu erstellen oder diese anzupassen muss Typst sowie Schriften installiert werden.

Wenn du VSCode und Devcontainers verwendest, wird alles automatisch für dich installiert.

Manuelle Installation

  1. Download der ausführbaren Datei https://github.com/typst/typst/releases
  2. Installation der Schriften Noto und Ubuntu
  3. Testen mit typst fonts ob Typst und die Schriften korrekt installiert sind

Generieren der PDFs

Manche Dateien müssen per YAML konfiguriert werden. In diesem Fall gibt es immer eine .yml.template-Datei, die das Format zeigt.

Linux

# automatisches Kompilieren bei Änderungen
typst watch spendenbescheinigung.typ

# einmaliges Kompilieren
typst compile spendenbescheinigung.typ

Windows

.\typst.exe compile .\spendenbescheinigung.typ

Änderungen

Wenn du etwas ändern willst oder du einen Fehler bemerkt hast, dann öffne gerne ein Issue und beschreibe möglichst genau dein Problem.

Alternativ kannst du die Änderung auch gerne selbst entwickeln und einen Pull Request stellen.