• Documentation
  • Repositories
  • Interactive Readme

Interactive Readme

CodeSandbox supports running tasks directly from Markdown.

CodeSandbox Preview

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.

CodeSandbox Code

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

CodeSandbox Play

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