Install in VS Code

Runme can be easily installed in VS Code as an extension.

The sections below will guide you through installing Runme on VS Code executing commands right inside your Markdown file.

Installing Runme on VS Code

To get started, follow the steps below:

1. Open up VS Code on your local machine.
2. Navigate to the Extension tab, which can be located on the dashboard on your left.
3. In your search bar, type "Runme". This will display the Runme Notebook extension.
4. Now click on Install to install the Notebook extension

Installing Runme From the VS Code Marketplace

Alternatively, you can install Runme from the VS Code Marketplace. To do this, follow the steps below.

1. Go to the VS Code Marketplace
2. Next, click on the Install button.

You have successfully installed Runme! 🎉

Available features

You can now open any Markdown file (*.md or *.mdx) with VS Code, and it will open as a Runme notebook.

1. Notebooks Explorer: You can easily access all your Markdown files using the Notebook Explorer. This will display all Markdown files existing in your project directory.
2. Cell Execution Status Indicator: When a code block is executed, the status indicator displays an icon that indicates the status of the executed code. If the code fails, an “X” symbol is returned, indicating failure; however, if the code is successfully run, a symbol, as seen in the image above, is displayed.
3. Cell Execution Result: View the executed cell result using the integrated VS Code terminal and prevent context switching using this terminal.
4. Run Cell Button: Running code in Markdown files is now easier with just one click.
5. Cell Code Block: Get a visual representation of commands to be executed with syntax highlighting.
6. Notebook Global Actions: View common options that define your code input and execution in the context of the Notebook.
7. Cell Code Block Actions: List of actions that define code block execution. This includes cell language, configurations etc.
8. Cell Execution Result: Copy your generated output.

Configure your default Markdown editor

If you want to change your default Markdown file viewer in VS Code, follow the steps below:

1. Right-click on any .md or .mdx file in the explorer window (in the directory file list, not under Open Editors).
2. Select Open With
3. Select Configure default editor at the bottom of the list

Here is a visual representation of these steps:

Alternatively, set the following in your .vscode/settings.json file of your project:

// ...
"workbench.editorAssociations": {
    "*.md": "runme"
    // ...
  },
  // ...

Bleeding Edge Features

Runme has a pre-release version with every new update made to the extension:

1. Go to the Extension tab on VS Code
2. Search for Runme
3. Click Switch to Pre-release Version to access new pre-released updates.

If you don't see this option, make sure your VS Code is updated to at least version 1.63.0.

How Runme Works in VS Code

Next up, Get Started, and explore verything you can do with the extension.