markdown-body entry-content container-lg" itemprop="text">

CodeRoad VSCode

CodeRoad is a VSCode extension that allows you to play interactive coding tutorials in your editor.

Getting Started

To start the extension, inside VSCode:

open an empty VSCode workspace (an empty folder)
launch the app from the VSCode command palette:
- select “View” > “Command Palette” from the top panel OR press cmd/ctrl + shift + P
- in the command palette, search for and run CodeRoad:Start
a webview should appear on the right side of your editor. Click "Start"

Build and share your own interactive tutorials.

See an interactive visualization of a tutorial repository.

Tutorials can be edited directly as markdown on Github.

To run the extension locally:

copy environmental variables from /web-app/.env.example as /web-app/.env
install dependencies with yarn install-all
build the extension with yarn build
open the extension with the vscode extension debugger by pressing F5. In the new window, open CodeRoad.

To test a packaged build locally:

CodeRoad is an ambitious project, we're always looking for contributors :)