A command line tool which allows you to run the code in your markdown files to ensure that readers always have access to working code.
Project description
Docrunner
A command line tool which allows you to run the code in your markdown files to ensure that readers always have access to working code.
What does it do?
Docrunner goes through your markdown file and runs any code in it, providing you safe testing for any markdown documentation. You can specify the path to the markdown file, along with other options, with flags.
Installation
Use the package manager pip to install docrunner.
pip install docrunner
QuickStart
docrunner --help
Language Specific Help
For help on a specific language, run:
docrunner <language> --help
Python Example
docrunner python --markdown-path example/example.md --multi-file
This command executes all python within example.md
and does so by putting each snippet of python from this file into a separate file, and running each file. If you don't want each snippet in a separate python file, just remove the --multi-file option.
Contributing and Local Development
Please check the CONTRIBUTING guidelines for information on how to contribute to docrunner.
Supported Languages
- Python -
docrunner python --help
- Javascript -
docrunner javascript --help
- Typescript -
docrunner typescript --help
- Dart -
docrunner dart --help
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for docrunner-0.1.8-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6c8f5e6ea8dd84b2b120a9979910b73b8851f4984f792e9768ea8e008b9eaf4c |
|
MD5 | 6a0c4eaf49354a6007407bb2c0a9d4ab |
|
BLAKE2b-256 | 18aec4ce8e770369f6f5e96f4d218ec6492fa7f59de53a7f6bedc35d539d20cf |