- Belgelerdeki kod snippet'lerini gerçekten çalıştırılabilir hale getirerek runbook, operasyon belgeleri ve README'lerin kullanışlılığını/güvenilirliğini artırmak için geliştirildi
- Markdown içindeki kod bloklarını olduğu gibi çalıştırarak belgeleri adım adım kolayca takip etmeyi ve doğrulamayı mümkün kılar
- Komutları çalıştırır, ara sonuçları kontrol eder ve istenen çıktının elde edilip edilmediğini doğrular
- Shell/Bash, Python, JavaScript/TypeScript, Ruby gibi çeşitli runtime'ları shebang tabanlı olarak destekler
- Kod hücreleri çalıştırılırken ortam değişkenlerini ve çalışma bağlamını korur; böylece bir terminal oturumu gibi adım adım yürütme yapılabilir
- Önceki hücrenin çıktılarını bir sonraki hücreye aktaran pipeline tarzı yürütme akışını da destekler
- Makefile, npm scripts, Gradle, Deno task gibi mevcut görev tanımlarıyla tamamen uyumludur
run, list, print komutlarıyla belge içindeki çalıştırılabilir iş akışlarını keşfetmek, çalıştırmak ve doğrulamak mümkündür- Operasyon belgelerindeki bitrot sorununu azaltır ve özellikle adım adım yürütme gerektiren gerçek iş belgeleri için uygundur
- bitrot: belge veya kodun zamanla gerçek ortamla uyumsuz hale gelerek giderek güvenilirliğini yitirmesi
- Homebrew, npm, Go install, tekil binary gibi yöntemlerle kurulabilir
- Apache 2.0 lisansı
Henüz yorum yok.