Text-Runner is an agile documentation tool that helps create living end-user readable documentation. An example is the text you are reading right now, which TextRunner verifies for correctness.

If you tell it how, TextRunner can read and understand any form of Markdown-formatted text in any human language as well as complex data in tables, bullet point lists, and even embedded images!

For users

• how it works
• installation
• built-in actions
• user-defined actions
  • example actions
• Q&A
• related tools

Plugins

• verify source code files
• modify/verify workspace files
• run executables in a subshell
• run/verify embedded JavaScript code
• verify Makefile targets
• verify the documentation of npm modules
• verify the documentation of Text-Runner plugins

For developers

This mono-repository contains the source code for the Text-Runner engine, tooling, and some plugins containing popular actions.

• developers guide
• text-runner-core: the Text-Runner engine
• text-runner-cli: runs Text-Runner on the command line
• text-runner-features: end-to-end tests for core and CLI
• shared test code