This VS Code extension transparently opens markdown files (i.e. README.md) as runnable VS Code notebooks (with the click of a
This project is open source licensed under APL2.0 and its code can be found in the following repos:
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.
If you don't want the runme notebook, you can always right click on the .md file, click
Elevated Notebook Experience
Code blocks with
Auto-detection for will be applied to blocks without language designators. Runme however prefers to add language designators to all code blocks.
Run in the background, great for compilers/bundler with file watchers.
Notebook cells will launch a task inside of the terminal panel by default to allow for user-input. However, if code blocks do not require user interactivity it is possible to run them inline.
Environment variables which are exported will prompt users for input. If their values are quoted Runme will prepopulated the value as placeholder when prompting the user whereas unquoted values will be displayed as prompt message with empty value instead.
Please see runme.dev's README.md for a reference how to apply these code block attributes in different use-cases.
Interactive Service integrations
Runme strives to break out of the terminal without losing interoperability with the CLI to document how the your repo ties together an array for external services. To showcase how this works take a look at the GIF below or run through Runme.dev's website README.
What's happening is whenever Deno's
Let us know what other services you rely on.
How It Works
Runme currently consists of a Markdown processor (written in Go) which is both linked in this VS Code extension (via WebAssembly) and the runme CLI (Go binary) allowing for a consistent experience. The Runme VS Code extension leverages the notebook APIs to transparently provide an interactive user experience on top of static markdown.
Bleeding Edge Software
Runme is alpha software that is under heavy development. Here are a few known limitations:
We would love to hear feedback, appreciate your patience, as Runme continutes to harden. Get in touch please!