Open Source
Testdocs
Extrahiert TypeScript-Codeblöcke aus Markdown und führt sie als Tests aus, sodass Beispiele und Code synchron bleiben.
Aufnahmetestdocs.dev
Testdocsausführbare Beispiele in der Dokumentation
Was es ist
Ein Testgerüst für Dokumentation. Es extrahiert TypeScript-Codeblöcke aus Markdown-Dateien und führt sie als echte Tests unter Vitest oder Jest aus, sodass die Beispiele in einer README Teil der Testsuite werden, ohne dass beides doppelt gepflegt werden muss.
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
Statische und serverseitig gerenderte Websites, die nah beim Nutzer laufen und günstig im Unterhalt sind.
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.