Zum Inhalt springen

Dokumentation

findsl docgen aggregiert die Markdown-Doc-Kommentare aller Module zu einem zusammenhängenden Dokument — in einem Bundessteuerblatt-nahen Layout, mit §-Verweisen und Formeln.

Terminal-Fenster
findsl docgen <pfad> -f <format> -o <ziel>
OptionBedeutung
<pfad>.findsl-Datei oder Verzeichnis (aggregiert über den Modul-Graph)
-f, --formatmd, html, pdf oder all (Default: all)
-o, --outAusgabe-Basisname (ohne Endung; Default: doc)
-k, --kopfMarkdown-Datei mit Front-Matter für Titelseite/Einleitung
Terminal-Fenster
findsl docgen examples/est -f all -o out/est-doku
  • Eine aggregierte Doku über alle Module, nach Bereichen gruppiert (Konstanten, Datensätze, Aufzählungen, Funktionen, Prüfungen).
  • @param/@rückgabe werden 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.
  • 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.

Mit -k lässt sich eine Front-Matter-Datei mitgeben, die Deckblatt und Einleitung steuert (Titel, Untertitel, Autor, Lizenz, weitere Metadaten):

Terminal-Fenster
findsl docgen examples/est -f pdf -k examples/est/est-doku.kopf.md -o out/est-doku

Ohne -k werden Titel und Untertitel aus dem ersten Modul abgeleitet.