<sectionid="{{ include.link }}">

<aclass="button edit-docs"href="//github.com/coderoad/coderoad.github.io/edit/master/_posts/{{ include.editPath }}/{{ include.file }}">

<iclass="fa fa-pencil fa-fw"></i>

<spanclass="network-name">Edit</span>

<h2>{{ include.index}}. {{ include.title }}</h2>

<div>{{ include.content }}</div>

<sectionid="{{ include.id }}">

<aclass="button edit-docs"href="{{ include.editPath }}/{{ include.file }}">

<iclass="fa fa-pencil fa-fw"></i>

<spanclass="network-name">Edit</span>

<h2>{{ include.title }}</h2>

<div>{{ include.content }}</div>

<sectionid="docs">

<divclass="doc-contents">

<h2>Contents</h2>

{% for doc in site.categories[include.category] reversed %}

{% include table-of-contents.html

link=doc.link

title=doc.title

index=forloop.index

%}

{% endfor %}

{% for doc in site.categories[include.category] reversed %}

{% include doc.html

link=doc.link

title=doc.title

content=doc.content

editPath=include.category

file=doc.file

index=forloop.index

%}

{% endfor %}

<ahref="#{{ include.link }}">

<h5>{{include.index}}. {{ include.title }}</h5>

title:What is Atom-CodeRoad?

id:explanation

link:explanation

file:2016-01-01-explanation.md

categories:

-atom-coderoad

title:Quick Start

id:install

link:install

file:2016-01-02-installation.md

categories:

-atom-coderoad

title:What is Builder-CodeRoad?

id:explanation

link:explanation

file:2016-01-01-explanation.md

categories:

-builder-coderoad

title:Quick Start

id:install

link:install

file:2016-01-02-installation.md

categories:

-builder-coderoad

title:Development

id:development

link:development

file:2016-01-02-development.md

categories:

-builder-coderoad

title:Tutorial Markdown

id:tutorial-md

link:tutorial-md

file:2016-01-01-tutorial.md

categories:

-docs

-tutorial-docs

CodeRoad tutorials are written in Github Flavored Markdown, then parsed into a*coderoad.json* file when you run`> coderoad build`.

title:CodeRoad API

id:coderoad-API

link:coderoad-API

file:2016-01-02-coderoad-api.md

categories:

-docs

-tutorial-docs

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`.

title:Unit Testing

id:tests

link:tests

file:2016-01-03-tests.md

categories:

-docs

-tutorial-docs

Unit tests are used to determine:

title:Loaders

id:test-loaders

link:test-loaders

file:2016-01-04-loaders.md

categories:

-docs

-tutorial-docs

Loaders are hidden behind comments, which may differ based on the programming language or compiler.

title:Test Snippets

id:test-snippets

link:test-snippets

file:2016-01-05-test-snippets.md

categories:

-docs

-tutorial-docs

Test Runners may have pre-made[Atom snippets](https://atom.io/docs/latest/using-atom-snippets) to quickly generate test files. See[*mocha-coderoad* snippets](https://github.com/coderoad/mocha-coderoad/blob/master/snippets.cson) as an example.

title:Test Examples

id:test-examples

link:test-examples

file:2016-01-06-test-examples.md

categories:

-docs

-tutorial-docs

Here are examples using*mocha* with*chai*'s*expect*. See the[Chai/Expect docs](http://chaijs.com/api/bdd/). Also keep in mind that most uses cases are covered by[test snippets](#test-snippets).

title:Config

id:config

link:config

file:2016-01-07-config.md

categories:

-docs

-tutorial-docs

CodeRoad tutorial configurations can be set in the*package.json* config.

title:Publishing

id:publish

link:publish

file:2016-01-08-publish.md

categories:

-docs

-tutorial-docs

Make sure your tutorial is ready and user tested before publishing to NPM.

title:Test Runners

id:test-runners

link:test-runners

file:2016-01-09-test-runner.md

categories:

-docs

-tutorial-docs

A CodeRoad test runner works by creating a child process and calling a test framework with target files, then returning the result as a JSON object.

title:Roadmap

id:roadmap

link:roadmap

file:2016-01-10-roadmap.md

categories:

-docs

-tutorial-docs

CodeRoad will become more flexible & powerful with time.

opacity:0.85;

}

.doc-contents {

padding-left:30px;

}

.edit-docs {

float:right;

}

repo: //github.com/coderoad/atom-coderoad

---

{% for doc in site.categories.atom-coderoad reversed %}

{% include docs.html

id=doc.id

title=doc.title

content=doc.content

editPath="//github.com/coderoad/coderoad.github.io/edit/master/_posts/atom-coderoad"

file=doc.file

%}

{% endfor %}

{% include docs.html category="atom-coderoad" %}

repo: //github.com/coderoad/builder-coderoad

---

{% for doc in site.categories.builder-coderoad reversed %}

{% include docs.html

id=doc.id

title=doc.title

content=doc.content

editPath="//github.com/coderoad/coderoad.github.io/edit/master/_posts/builder-coderoad"

file=doc.file

%}

{% endfor %}

{% include docs.html category="builder-coderoad" %}

threshold :200,

target=target.length ?target :$('[name='+this.hash.slice(1)+']');

scrollTop:target.offset().top

{% for doc in site.categories.docs reversed %}

{% include docs.html

id=doc.id

title=doc.title

content=doc.content

editPath="//github.com/coderoad/coderoad.github.io/edit/master/_posts/tutorial-docs"

file=doc.file

%}

{% endfor %}

{% include docs.html category="tutorial-docs" %}