Run code blocks from your markdown docs as real tests. Mark a fenced block with
test, and it becomes a runnable assertion — no separate test file, no
boilerplate, no drift between docs and code.
| Language | Package | Runs in | Docs |
|---|---|---|---|
| TypeScript | irondocs |
vitest, vite-plus, jest | Introduction |
| Python | irondocs |
pytest | Introduction |
Both packages share one contract: the same fence marker, the same test names
from the nearest heading, the same name="...", skip and only options and
the same hoisting of imports across a file's blocks. This repository holds both
implementations — typescript/ and python/; see
Contributing for the layout and the commands.
.skills/ holds irondocs-tests, a skill that teaches coding agents to write, wire
and debug markdown tests with Irondocs. Copy it into your agent's skills directory to use it.