Open source
Irondocs
Exécute les blocs de code de la documentation Markdown comme de vrais tests pytest, vitest ou jest, pour que les exemples ne s'écartent jamais du code.
captureirondocs.dev
Irondocsune documentation qui s'exécute en tests
Ce que c'est
Un harnais de test pour la documentation. Marquez un bloc de code d'un fichier Markdown comme test et il s'exécute comme une vraie assertion — sous pytest en Python, ou vitest ou jest en TypeScript — nommé d'après le titre le plus proche, sans fichier de test séparé.
Pourquoi il existe
Les exemples de documentation pourrissent en silence. Une API change, les tests sont mis à jour, et le README continue de montrer l'ancienne signature jusqu'à ce que quelqu'un la copie et ouvre un bug. Exécuter les exemples est la seule façon de savoir qu'ils fonctionnent encore.
Notre part
Nous le maintenons, et il tourne contre notre propre documentation — c'est ainsi que les exemples des autres pages de projets restent honnêtes.
Ce sur quoi nous le construisons
Des tests unitaires rapides, du HTTP enregistré, et une documentation qui fait échouer le build quand elle se périme.
Une seule chaîne d'outils pour tous les dépôts : passer de l'un à l'autre ne coûte rien.
Nous contacter
Dites-nous ce que vous voulez faire construire.
Nous sommes une petite équipe au Portugal, aux horaires de Londres. Un site, une application, un outil interne, ou la plateforme derrière — commencez par une phrase sur le problème et nous prenons la suite.