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.
- Text is written in Markdown. 🔗
- Tutorials are built on Git using a TDD pattern. 🔗
- Hooks & actions give flexible access to the command line & VSCode API. 📖
- OS: MacOS, Linux, Windows
- VSCode 1.39.2+
- Git
- install CodeRoad from the VSCode Marketplace.
- reload the window (
ctrl/cmd + R) to get started.
To start the extension, inside VSCode:
-
Open an empty VSCode workspace (a project folder)
-
Launch the app from the VSCode command palette. How?
- select “View” > “Command Palette” from the top panel OR press
cmd/ctrl + shift + P - in the command palette popup, search for and run
CodeRoad:Start
- select “View” > “Command Palette” from the top panel OR press
CodeRoad is an ambitious project, we're always looking for contributors :)
See CONTRIBUTING.md.
- Create a GitHub issue for bug reports, feature requests, or questions
- Reach out at
coderoadapp@gmail.com - Leave a review in the VSCode Marketplace
- Add a ⭐️ star on GitHub to support the project!