CodeRoad is a free plugin for the popular[Atom Editor]("https://atom.io").

With the "atom-coderoad" plugin,code in a real editor environment alongside your other favorite plugins.

With the "atom-coderoad" plugin,take tutorials in a real editor environment alongside your other favorite plugins.

We hope to create fun and maintainable code tutorials thatactuallyimprove with time. We hope to see programming students become teachers, teachers become empowered, and coders become better, faster. But first, let's get some interactive coding tutorials built. That's where you come in.

We hope to create fun and maintainable code tutorials that improve with time. We hope to see programming students become teachers, teachers become empowered, and coders become better, faster. But first, let's get some interactive coding tutorials built. That's where you come in.

}

Normally you would use`> npm install` to install the package, but your package isn't ready to be published yet. Instead, you need to link your tutorial package to your demo directory.

Normally you would use`> npm install` to install the package, but your package isn't ready to be published yet. Instead, you need to*"link"* your tutorial package to your demo directory.

[NPM link](https://docs.npmjs.com/cli/link) creates a symbolic link between directories. This allows your demo directory to always load your tutorial package.

Inside of your tutorial root directory, run link.

Inside of your tutorial root directory, runnpmlink.

Open*Atom-Coderoad* toview your tutorial.Your package should appear as a loaded package. Click on it.

Use[*Builder-CodeRoad*](/builder-coderoad.html) todevelop your tutorial.Builder-CodeRoad allows you to visualize and test your tutorial as you develop it.

Reload*Atom* to view changes. You can use the Atom[command-palette](https://atom.io/docs/latest/getting-started-atom-basics#command-palette) to find "reload" or simply use the reload hot-key (*Windows & Linux*: alt-ctrl-r,*Mac*: ctrl-alt-cmd-l).

When it's ready, you can play your tutorial in*Atom-Coderoad*. Your package should appear as a loaded package. Click on it.

If you make any changes to your tutorial, you'll have to reload*Atom* to view them. You can use the Atom[command-palette](https://atom.io/docs/latest/getting-started-atom-basics#command-palette) to find "reload" or simply use the reload hot-key (*Windows & Linux*: alt-ctrl-r,*Mac*: ctrl-alt-cmd-l).

Of course Markdown couldn't cover all uses necessary for CodeRoad. Instead, there is a special**CodeRoad API** which is parsed into the data file whenever you run`> coderoad build`.

For these API features to work, they must be placed at the beginning of a line.

For these API features to work, they must be placed at the*beginning of a line*.

@import('file') // ✓

@import('./path/to/file.md')

See an[example](https://github.com/coderoad/coderoad-functional-school/blob/master/tutorial/tutorial.md).

See an[example tutorial file](https://github.com/coderoad/coderoad-functional-school/blob/master/tutorial/tutorial.md).