Find bugs in your docs by running them first


Broken docs suck

Run your docs before publishing them.

npm install docrunner

Docrunner differs from other doctest type solutions in a number of ways:

  • no new globals (no print, no wait, no log, etc.)
  • no extra characters (no prompt js> or continuation ..., no special comments // =>)
  • allows copy/paste of snippets directly to/from the repl
  • handles async assertions and errors naturally

See what works by running the tests.

npm test