SimDem provides an easy way to convert tutorials written in markdown into interactive demos and automated tests.
SimDem supports the following features:
- Command execution
- Environment variable injection
- Prerequisites
- Output validation
Details on the complete feature list can be found in the feature documentation.
Currently, only available for installation in development mode:
git clone git@github.com:Azure/simdem.git
git checkout -b simdem2 remotes/origin/simdem2
pip3 install -r requirements.txt
pip3 install -v -e .
If you are experiencing issues with installation, please see these issues:
After installing, a great place to start is to run SimDem on its own documentation.
simdem docs/README.md
You can learn how how SimDem works by reading the docs.
Here is a simple hello-world example.
If you want to see existing examples, with expected output, check out the examples
Currently, SimDem supports Markdown as the source document. Details on how to compose Markdown documents can be found in the syntax documentation.
We would love to have you be a part of the SimDem development team. For details, see the development documentation.
SimDem v2 is a complete rewrite of SimDem v1. The latest commit for v1 can be found at: https://github.com/Azure/simdem/tree/cb1caf17fd684e125789c26817f43eeae0e1c523
This project is licensed under the MIT License - see the LICENSE.md file for details.
- Ross Gardler - The original creator of SimDem
- Mi Yu - Author of Mistletoe who provided guidance on Markdown parsing
- Tommy Falgout - Author of SimDem v2