项目作者: coderoad

项目描述 :
👩‍💻 Create or play Interactive coding tutorials in VSCode
高级语言: TypeScript
项目地址: git://github.com/coderoad/coderoad-vscode.git
创建时间: 2019-05-26T05:39:40Z
项目社区:https://github.com/coderoad/coderoad-vscode

开源协议:GNU Affero General Public License v3.0

下载




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