Repository files navigation

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

Works with a variety of languages: JavaScript, Python, Bash, SQL, with more to come.

• Create a Tutorial
• Develop the Extension

1. Text is written in Markdown.🔗
2. Tutorials are built on Git using a TDD pattern.🔗
3. Hooks & actions give flexible access to the command line & VSCode API.📖

▶️  See a video explaining how CodeRoad works

📖  Learn more

• OS: MacOS, Linux, Windows
• VSCode 1.39.2+
• Git

1. install CodeRoad fromthe VSCode Marketplace.
2. reload the window (ctrl/cmd + R) to get started.

To start the extension, inside VSCode:

• Open anempty VSCode workspace (a project folder)

• Launch the app from the VSCode command palette. How?

  • select “View” > “Command Palette” from the top panel OR presscmd/ctrl + shift + P
  • in the command palette popup, search for and runCodeRoad:Start

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

SeeCONTRIBUTING.md.

AGPL v3

• Create aGitHub issue for bug reports, feature requests, or questions
• Reach out atcoderoadapp@gmail.com
• Leavea review in the VSCode Marketplace
• Add a ⭐️ star on GitHub to support the project!