In den letzten Tagen bin ich wieder einmal im sprichwörtlichen Kaninchenbau versackt.
Aber ganz von vorne: Am Samstag habe ich einen Blogbeitrag geschrieben, um einen automatisierten und deterministischen Dokumenten-Workflow zu veranschaulichen.1 Zur besseren Nachvollziehbarkeit habe ich außerdem ein Codeberg-Repository angelegt.2
Das Feedback war überraschend überwältigend und enthielt viele berechtigte Punkte. Tatsächlich war das Repo ursprünglich eher schnell als gründlich zusammengestellt, so dass ich es deutlich überarbeitet und im Zuge dessen auch umbenannt habe. Jetzt ist es mehr als nur ein Anschauungsobjekt. Es bildet nun einen vollständigen, sehr flexiblen und zugleich sehr einfachen Dokumenten-Workflow ab.
Grundlegende Logik des Ablaufes als Mermaid im Repo
Besonders erwähnenswert sind das Frontmatter und die Verwendung von selbst erweiterbaren Snippets oder Textbausteinen innerhalb der Markdown-Dokumente - sowohl zeilenweise als auch inline im Präprozessor. Dazu kommt eine automatische Erstellung von PDF-Formularen im Postprozessor sowie die übersichtliche Struktur.
Und das alles mit einer sehr überschaubaren Abhängigkeits-Liste: Bash, git, pandoc, LaTeX, pdfcpu und curl. Zur Verdeutlichung der dynamischen Snippets lasse ich jeweils beim Build die aktuellen Heise-News “ins Markdown laufen”. In der Praxis wären das natürlich eher Asset- oder Ticketlisten aus REST-APIs. Your mileage may vary. Die drei anderen PDF-Dokumente sind übrigens Teil meiner produktiven Dokumentensammlung und ziemlich “wasserdicht”.
Das soll für den Moment reichen. Ich bin jedenfalls wieder aus dem Kaninchenbau heraus.
Forks und Pull-Requests sind ausdrücklich erwünscht. Damit statische Dateisammlungen in verschachtelten Verzeichnisstrukturen Compliance nicht nur vortäuschen, sondern tatsächlich auch leben und gelebt werden.
In diesem Sinne,
Euer Tomas Jakobs