This VS Code extension transparently opens markdown files (i.e. README.md) as runnable VS Code notebooks (with the click of a play button). Annotating markdown code blocks repo maintainers can enhance the interactive runbook-like experience of their markdown notebooks while they will continue to render properly in markdown viewers. Runme is open source and licensed under APL2.0.
💡 If you don't want the runme notebook, you can always right click on the .md file, click Open With... and select the text editor. To make your choice permanent pick "Configure default editor for...".
Documentation
Please visit Runme's documentation to learn about its purpose, all its features, and how to get the most out of it:
Feel free to submit any issues you may have via the
issue tracker or tell us about it on Discord.
Installation
Comprehensive install instructions are available in the docs at https://docs.runme.dev/install.
Usage
After cloning into a repo in VS Code, open any markdown file and notice that instead of opening the markdown file content, in renders a notebook where shell commands are rendered as runnable blocks. Please see Runme's Getting Started guide for step-by-step instructions.
If you don't want the runme notebook, you can always right click on the .md file, click Open With... and select the text editor. To make your choice permanent pick "Configure default editor for...".
Runme allows code blocks to be annotated with attributes to provide control over some aspects of execution, output, interaction, and other behavior. Please find a complete list in the docs.
For instance, the following annotation will run the command in the background, great for compilers/bundler with file watchers. To enable or disable any of the available options just click the respective cell's Configure button.
```sh { background=true }
npx tsc --watch
```
Check the complete list of configuration options at https://docs.runme.dev/configuration or take a look at the examples which are also illustrated in Runme's integration docs.
Maturing Software
Runme is in rapid development. Please be aware of following known limitations:
- Only shell is currently supported on macOS, Linux, and Windows (WSL). PowerShell is not supported yet
- Be aware of edge cases. Let us know when you hit any snags. We appreciate it!
We would love to hear feedback, appreciate your patience, as Runme continutes to harden. Get in touch please!
