Open Source
Irondocs
Führt die Codeblöcke in Markdown-Dokumentation als echte pytest-, vitest- oder jest-Tests aus, damit Beispiele nicht vom Code abweichen können.
Aufnahmeirondocs.dev
IrondocsDokumentation, die als Test läuft
Was es ist
Ein Test-Harness für Dokumentation. Markieren Sie einen Codeblock in einer Markdown-Datei als Test, und er läuft als echte Assertion — unter pytest in Python oder vitest bzw. jest in TypeScript — benannt nach der nächstgelegenen Überschrift, ohne separate Testdatei.
Warum es existiert
Beispiele in der Dokumentation verrotten still. Eine API ändert sich, die Tests werden angepasst, und die README zeigt weiter die alte Signatur, bis jemand sie kopiert und einen Fehler meldet. Die Beispiele auszuführen ist der einzige Weg zu wissen, dass sie noch funktionieren.
Unser Anteil daran
Wir pflegen es, und es läuft gegen unsere eigene Dokumentation — so bleiben die Beispiele auf den anderen Projektseiten ehrlich.
Worauf wir es bauen
Schnelle Unit-Tests, aufgezeichnetes HTTP und Dokumentation, die den Build scheitern lässt, sobald sie veraltet.
Eine Toolchain über alle Repositories hinweg, sodass der Wechsel zwischen ihnen nichts kostet.
Kontakt aufnehmen
Sagen Sie uns, was gebaut werden soll.
Wir sind ein kleines Team in Portugal und arbeiten zu Londoner Zeiten. Eine Website, eine App, ein internes Werkzeug oder die Plattform dahinter — beginnen Sie mit einem Satz zum Problem, den Rest übernehmen wir.