Awesome Open Source
Awesome Open Source
Sponsorship

CodeRoad Logo

CodeRoad

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.

CodeRoad Example


πŸ“– Documentation

How CodeRoad Works

  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


Getting Started

Requirements

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

Install

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

Start

CodeRoad Example

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

Contributing

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

See CONTRIBUTING.md.

License

AGPL v3

Contact & Support

  • Create a GitHub issue for bug reports, feature requests, or questions
  • Reach out at [email protected]
  • Leave a review in the VSCode Marketplace
  • Add a ⭐️ star on GitHub to support the project!

Get A Weekly Email With Trending Projects For These Topics
No Spam. Unsubscribe easily at any time.
typescript (9,496)Β 
tutorial (899)Β 
vscode (344)Β 
vscode-extension (227)Β 
tutorial-code (35)Β 

Find Open Source By Browsing 7,000 Topics Across 59 Categories