CodeRoad VSCode

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

Getting Started

Start

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"

Install

Install CodeRoad from this link in the VSCode Marketplace.

You may need to reload the window (ctrl/cmd + R)
See "Start" to get started.

Requirements

OS: MacOS, Linux (Windows coming soon #227)
VSCode 1.40+
Node.js 10+
Git

Creating Tutorials

Build and share your own interactive tutorials.

Learn more about how tutorials area created.

Editing Tutorials

Tutorials can be edited directly as markdown on Github.

Contributing

See CONTRIBUTING.md.

License