Skip to main content


Everything in one place.

Document Options

Frontmatter in yaml, json, or toml on top of markdown document.

ConfigurationDescriptionDefault value
cwdOverwrites the default working directory[markdown file's basedir]
shellOverwrites shell with custom preference[system/user default]
skipPromptsBypasses interactive prompts[system/user default]

Cell Options

Metadata inside markdown's fenced code blocks.

ConfigurationDescriptionDefault value
backgroundIndicates if the cell should be runned as a background processfalse
closeTerminalOnSuccessHide Terminal after cell successful executiontrue
categoryExecute this code cell within a category[empty]
cwdModify current working directory for cell execution[empty]
excludeFromRunAllPrevent executing this cell during the "Run All" operationfalse
interactiveIndicates if run should allow interactive inputfalse
interpreterThe program or command line inserted into shebang (aka #!) lineinferred from languageId
mimeTypeCell’s output content MIME typetext/plain
nameCell’s canonical name useful for referencing the cell via CLIauto-generated
terminalRowsNumber of rows to display in the notebook terminalauto-set
promptEnvPrompt user to set exported environment varstrue
skipPromptsBypasses interactive prompts that require inputting environment vars or authentication confirmations.false

This feature can be used to prevent prompting when exporting an environment variable. By configuring the cell options appropriately, you can streamline your workflow and make your environment setup more efficient.

Supported MIME types

Runme supports the standard VS Code MIME types alongside custom Runme MIME types.

Standard VS Code MIME types

  • text/plain
  • application/javascript
  • text/html
  • image/svg+xml
  • text/markdown
  • image/png
  • image/jpeg

MIME types for rendering code

  • text/x-json
  • text/x-javascript
  • text/x-html
  • text/x-rust
  • text/x-LANGUAGE_ID for any other built-in or installed languages.