Find bugs in your docs before publishing them.
JavaScript
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
lib
test
.gitignore
.travis.yml
Gruntfile.js
README.md
package.json

README.md

docrunner

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

Tests

See what works by running the tests.

npm test

Current Status