Quarkdown bringt Funktionen und Variablen in Markdown
Victoria Shinder2 Min. LesezeitMarkdown gewinnt, weil es klein ist — und verliert aus demselben Grund: Sobald ein Dokument einen wiederkehrenden Block, einen berechneten Wert oder ein zweites Ausgabeformat braucht, schreibt man ein Build-Skript darum herum oder wechselt zu LaTeX. Quarkdown versucht, diese Lücke von der Markdown-Seite zu schließen: ein Superset, in dem Funktionen und Variablen zur Sprache gehören, sodass wiederholter Inhalt zu einem einzeiligen Aufruf wird statt zu einer Kopie.
Die interessantere Hälfte ist die Ausgabe. Aus einer Quelle entstehen mehrere Dokumenttypen, ausgewählt im Dokument selbst: ein einfaches Dokument, ein paginiertes für Aufsätze und Bücher, Folien oder eine Dokumentationsseite — das eigene Wiki des Projekts umfasst über hundert Seiten und wird auf diesem Weg gebaut; als Übersetzungszeit werden wenige Sekunden genannt. HTML und PDF sind gleichrangig, das paginierte Layout übernimmt paged.js, die Folien reveal.js; dazu Export nach Markdown und reinem Text.
Mitgeliefert wird außerdem das, woran sich entscheidet, ob ein Werkzeug den Alltag übersteht: ein Kommandozeilen-Compiler, ein Language Server, Live-Vorschau und ein dokumentierter Weg für automatisierte Builds. Funktionen sind beim Zugriff auf Systemressourcen gekapselt — die richtige Voreinstellung für eine Sprache, die Leute unweigerlich auf fremde Dokumente loslassen.
Das Repository stellt eine Vergleichstabelle gegen LaTeX und die üblichen Markdown-Ketten nach oben, was unmissverständlich sagt, worauf es zielt. Lizenz: GPLv3 für den Kern, CLI und Language Server unter AGPLv3.
Was das bedeutet
Das benannte Problem ist echt, und die meisten Teams lösen es schlecht. Dokumentation, die Bedingungen und gemeinsame Fragmente braucht, endet üblicherweise als Markdown plus Template-Schicht plus Site-Generator plus PDF-Schritt, zusammengeklebt von jemandem, der inzwischen gekündigt hat. Die Logik in die Dokumentsprache zu legen ist nicht offensichtlich richtig, aber immerhin eine Entscheidung statt vier.
Das Risiko ist dasselbe wie bei jedem erweiterten Markdown: Mit einem einfachen Leser ist es nicht mehr lesbar. Der Wert von Markdown liegt darin, dass jeder Editor, jede Code-Plattform und jeder Generator es versteht. Ein Superset ist ein privater Dialekt — gut, wenn ein Team den gesamten Bestand besitzt, unangenehm, sobald Beitragende erwarten, dass die Vorschau in ihrem Editor dem entspricht, was veröffentlicht wird. Ein Blick ins eigene Repository genügt: Wie viele Dateien bräuchten den Dialekt wirklich, und wie viele trügen nur das Risiko?
Und „Turing-vollständig" ist Verkaufsargument und Warnung zugleich. Ein Dokument, das rechnen kann, kann auch nicht übersetzen, in eine Schleife laufen oder auf verschiedenen Maschinen Verschiedenes erzeugen — genau dafür gibt es in der LaTeX-Welt Reproduzierbarkeitswerkzeuge. Die Kapselung des Systemzugriffs ist der richtige Anfang; die nächste Frage bei einer Einführung lautet, ob derselbe Quelltext auf einer anderen Maschine in einem Jahr noch dasselbe PDF ergibt.
Einen Blick wert, wenn die eigene Dokumentation Markdown entwachsen ist und man aus Gewohnheit zu LaTeX greifen wollte.