Dokumentation
findsl docgen aggregiert die Markdown-Doc-Kommentare aller Module zu einem zusammenhängenden Dokument — in einem Bundessteuerblatt-nahen Layout, mit §-Verweisen und Formeln.
Der Befehl
Abschnitt betitelt „Der Befehl“findsl docgen <pfad> -f <format> -o <ziel>| Option | Bedeutung |
|---|---|
<pfad> | .findsl-Datei oder Verzeichnis (aggregiert über den Modul-Graph) |
-f, --format | md, html, pdf oder all (Default: all) |
-o, --out | Ausgabe-Basisname (ohne Endung; Default: doc) |
-k, --kopf | Markdown-Datei mit Front-Matter für Titelseite/Einleitung |
findsl docgen examples/est -f all -o out/est-dokuWas entsteht
Abschnitt betitelt „Was entsteht“- Eine aggregierte Doku über alle Module, nach Bereichen gruppiert (Konstanten, Datensätze, Aufzählungen, Funktionen, Prüfungen).
@param/@rückgabewerden zu Parameter-Tabellen, nicht zu rohem Fließtext.- §-Verweise:
@Quelle-Annotationen und §-Referenzen in der Prosa werden automatisch verlinkt. - Formeln:
$…$/$$…$$-Mathematik wird in HTML und PDF als echte Formel gerendert.
Formate
Abschnitt betitelt „Formate“- Markdown — kanonisch und deterministisch; ideal als Quell-/Austauschformat.
- HTML — Single-File im Starlight-Stil: Sidebar mit Suche, Light/Dark-Umschaltung, FinDSL-Syntax-Highlighting.
- PDF — redaktionell gestaltet: Deckblatt, Inhaltsverzeichnis, Kopf-/Fußzeilen, Syntax-hervorgehobene Code-Boxen.
Titelseite & Einleitung
Abschnitt betitelt „Titelseite & Einleitung“Mit -k lässt sich eine Front-Matter-Datei mitgeben, die Deckblatt und Einleitung steuert (Titel, Untertitel, Autor, Lizenz, weitere Metadaten):
findsl docgen examples/est -f pdf -k examples/est/est-doku.kopf.md -o out/est-dokuOhne -k werden Titel und Untertitel aus dem ersten Modul abgeleitet.