Skip to content
datisthqPublic

About

Docs that run in your test suite. Mark a code block in any .md file with test, and Irondocs runs it as a real pytest, vitest or jest test, with no drift between docs and code.

Topics

Resources

Contributing

Stars

2 stars

Watchers

0 watching

Forks

Latest commit

 

History

129 Commits

Folders and files

Repository files navigation

Irondocs

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.

Agent skills

.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.

About

Docs that run in your test suite. Mark a code block in any .md file with test, and Irondocs runs it as a real pytest, vitest or jest test, with no drift between docs and code.

Topics

Resources

Contributing

Stars

2 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages