Atom CodeRoad plugin

Interactive coding tutorials inside of the Atom editor. Learn more at coderoad.io.

** Currently beta. Post issues. **

QuickStart

Use Atom CodeRoad to view and play your tutorial

• Download the Atom editor

• Install the Atom-CodeRoad package, or use the apm command-line tool

  > apm install atom-coderoad
  

• Open Atom-CodeRoad in Atom using the "packages" menu or press ctrl-alt-1.

• It's recommended you also enable Autosave in Atom.

To enable autosave in Atom, go to Atom > Preferences > Packages > search for "autosave" > settings > check "enabled".

• If CodeRoad is unavailable under Atom > Packages > CodeRoad, restart or reload atom.

You can use the Atom command-palette to find "reload" or simply use the reload hot-key.

• Windows & Linux: alt-ctrl-r
• Mac: ctrl-alt-cmd-l

Install a Tutorial

To install a tutorial, setup a package.json file and save the tutorial as a dependency. Make sure NodeJS 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 created package.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 run Atom-CodeRoad you should see the tutorial appear on the first screen.