- Entwickelt, um Code-Snippets in Dokumenten tatsächlich ausführbar zu machen und so Nutzwert und Zuverlässigkeit von Runbooks, Betriebsdokumentation und READMEs zu erhöhen
- Codeblöcke in Markdown lassen sich unverändert ausführen, sodass Dokumente Schritt für Schritt leicht nachvollzogen und verifiziert werden können
- Befehle ausführen, Zwischenergebnisse prüfen und kontrollieren, ob die gewünschte Ausgabe erreicht wurde
- Unterstützt verschiedene Runtimes auf Shebang-Basis wie Shell/Bash, Python, JavaScript/TypeScript und Ruby
- Beim Ausführen von Code-Zellen bleiben Umgebungsvariablen und Ausführungskontext erhalten, sodass eine schrittweise Ausführung wie in einer Terminal-Sitzung möglich ist
- Unterstützt auch Pipeline-artige Ausführungsabläufe, bei denen die Ausgabe der vorherigen Zelle an die nächste weitergegeben wird
- Vollständig kompatibel mit bestehenden Task-Definitionen wie Makefile, npm scripts, Gradle und Deno task
- Mit den Befehlen
run, list und print lassen sich ausführbare Workflows in Dokumenten erkunden, ausführen und verifizieren
- Reduziert das Bitrot-Problem in Betriebsdokumentation und ist besonders geeignet für praxisnahe Dokumente, die eine schrittweise Ausführung erfordern
- Bitrot: das Phänomen, dass Dokumentation oder Code im Lauf der Zeit vom realen Umfeld abweichen und dadurch zunehmend an Vertrauenswürdigkeit verlieren
- Installation über Homebrew, npm, Go install oder als einzelnes Binärprogramm möglich
- Apache-2.0-Lizenz
Noch keine Kommentare.