Livemark

Ein Generator für Dokumentationsseiten. Er macht aus einem Verzeichnis voller Markdown-Dateien eine schnelle statische Website — Syntaxhervorhebung über Shiki, Diagramme über Mermaid, interaktive Komponenten über MDX sowie einen Blog und ein Changelog, die ohne zusätzliche Konfiguration funktionieren.

Werkzeuge für Dokumentation gibt es meist in zwei Größen: zu klein, um hineinzuwachsen, oder ein Framework, das gleich das ganze Projekt beanspruchen will. Livemark bleibt dazwischen — Markdown hinein, eine Website heraus, mit Notausgängen für die Seiten, die wirklich einmal etwas Ungewöhnliches tun müssen. Die Ausgabe ist statisch, es gibt also keinen Server zu betreiben, und sie lässt sich überall hosten, wo Dateien ausgeliefert werden.

Wir pflegen es, und wir nutzen es. Mehrere der hier aufgeführten Projekte dokumentieren sich damit, was ein zuverlässiger Weg ist, herauszufinden, wo die rauen Kanten sind.