Open source
Testdocs
Extracts TypeScript code blocks from Markdown and runs them as tests, keeping examples in sync with the code.
capturetestdocs.dev
Testdocsrunnable documentation examples
What it is
A test harness for documentation. It extracts TypeScript code blocks from Markdown files and runs them as real tests under Vitest or Jest, so the examples in a README become part of the test suite with no duplication between the two.
Why it exists
Documentation examples rot silently. An API changes, the tests are updated, and the README keeps demonstrating the old signature until somebody copies it and files a bug. Running the examples is the only way to know they still work.
Our part in it
We maintain it, and it runs against our own documentation — which is how the examples on the other project pages stay honest.
What we build it on
Static and server-rendered sites running close to the user, and cheap to keep up.
Fast unit tests, recorded HTTP, and documentation that fails the build when it goes stale.
One toolchain across every repository, so moving between them costs nothing.
Get in touch
Tell us what you need built.
We are a small team in Portugal, working London hours. A site, an app, an internal tool, or the platform behind them — start with a sentence about the problem and we will take it from there.