Runme for Visual Studio Code
This VS Code extension transparently opens markdown files (i.e. README.md) as runnable VS Code notebooks (with the click of a
DocumentationPlease 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. UsageAfter 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.
Configure Cell ExecutionRunme 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
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 SoftwareRunme is in rapid development. Please be aware of following known limitations:
We would love to hear feedback, appreciate your patience, as Runme continutes to harden. Get in touch please! |