Repository files navigation

Interactive coding tutorials inside of the Atom editor.

See avideo.

Read thedocs.

Currently beta. Please post issues.

UseAtom CodeRoad to view and play your tutorial.

You'll need to download theAtom editor and installAtom Shell Commands.

Install theAtom-CodeRoad package:> apm install atom-coderoad

For an example of how to do this, see the image below:

You may also want to installterminal-plus used in the example above.

Toggle openAtom-CodeRoad using thePackages menu or pressctrl-alt-0.

To install a tutorial, setup apackage.json file and save the tutorial as a dependency. Make sureNodeJS is already installed.

You can setup a project quickly by typing> npm init --y into the command line in your project's folder. This agrees to all of the defaults for your newly createdpackage.json file.

Now you can install a tutorial. Run> npm install --save-dev $THE-PACKAGE-NAME$ to save the tutorial as a package development dependency. If you runAtom-CodeRoad you should see the tutorial appear on the first screen.