Interactive Readme – CodeSandbox

Interactive Readme

CodeSandbox supports running tasks directly from Markdown.

To configure the interactive Readme:

  1. Define a task using the configuration file. Use the same shell command used in the tasks.json file in the markdown code block.

  2. If there is a match, CodeSandbox will render a play icon next to the command in the interactive view.

Interactive tasks can be run by any user with read access to your project.

[DevTools](/content/docs/learn/vm-sandboxes/devtools "DevTools"/index.html) [Preview](/content/docs/learn/vm-sandboxes/preview "Preview"/index.html)