Skip to content

Commit 3249498

Browse files
committed
move docs into organized markdown
1 parent d8ccec5 commit 3249498

24 files changed

+179
-104
lines changed

_config.yml

Lines changed: 0 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -50,17 +50,6 @@ social:
5050
#forumbee:
5151
#tripadvisor:
5252
#amazon:
53-
tutorials:
54-
- Functional School:
55-
title: Functional School
56-
language: JS
57-
url: https://github.com/coderoad/coderoad-functional-school
58-
description: A trip through functional programming in Javascript using common built-in Javascript array methods such as map & reduce.
59-
- ES2015:
60-
title: ES2015
61-
language: JS
62-
url: https://github.com/shmck/coderoad-es2015
63-
description: Practice refactoring with ES2015 features.
6453

6554

6655
# Build settings
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
layout: docs
3+
title: What is Atom-CodeRoad?
4+
id: explanation
5+
file: 2016-01-01-explanation.md
6+
categories:
7+
- atom-coderoad
8+
---
9+
10+
Coming soon...
Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
---
2+
layout: docs
3+
title: Quick Start
4+
id: install
5+
file: 2016-01-02-installation.md
6+
categories:
7+
- atom-coderoad
8+
---
9+
10+
To play a **tutorial**, you'll only need **Atom-CodeRoad**.
11+
12+
### Requirements
13+
14+
Atom CodeRoad has several key dependencies before starting:
15+
16+
* **NodeJS** > 0.10.x. Check your version with `> node -v`.
17+
- download a newer version [here](https://nodejs.org).
18+
* **NPM** 3.x+. Check your version with `> npm -v`.
19+
- NPM comes installed with NodeJS
20+
- update with `> npm install -g npm`
21+
* **Atom Editor**
22+
- A popular code editor available at [Atom.io](https://atom.io/)
23+
24+
### Install
25+
26+
You can install Atom packages inside of Atom through the following menus: "Atom -> Preferences -> Install", and search for "atom-coderoad".
27+
28+
You may also choose to install *Atom Shell Commands* under the "Atom" menu. Shell commands allow you to quickly install Atom packages from the command line, for example: `> apm install atom-coderoad`.
29+
30+
### Start
31+
32+
Toggle open *Atom-CodeRoad* using the *Packages* menu or press *ctrl-alt-0*.
33+
34+
35+
### Tutorial
36+
37+
To install a tutorial, setup a *package.json* file and save the tutorial as a dependency.
38+
39+
![Install a Tutorial](/images/docs/install-tutorial.png){: .gif}
40+
41+
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.
42+
43+
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 tutorial list screen.
44+
45+
> If you are stuck at a screen that says 'install a tutorial', try updating your version of NPM to 3.x+.
46+
47+
### Recommended
48+
49+
##### Enable Autosave
50+
51+
It's recommended you also enable *autosave* in Atom.
52+
53+
![Enable autosave in Atom](/images/docs/autosave.png){: .gif}
54+
55+
Tutorials run unit tests on save, *autosave* can speed up the process.
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
layout: docs
3+
title: What is Builder-CodeRoad?
4+
id: explanation
5+
file: 2016-01-01-explanation.md
6+
categories:
7+
- builder-coderoad
8+
---
9+
10+
Coming soon...
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
layout: docs
3+
title: Quick Start
4+
id: install
5+
file: 2016-01-02-installation.md
6+
categories:
7+
- builder-coderoad
8+
---
9+
10+
To create a **tutorial**, you'll need **Builder-CodeRoad**.
11+
12+
### Requirements
13+
14+
Builder CodeRoad has several key dependencies before starting:
15+
16+
* *NodeJS* > 0.10.x. Check your version with `> node -v`.
17+
- download a newer version [here](https://nodejs.org).
18+
* *NPM* 3.x+. Check your version with `> npm -v`.
19+
- update with `> npm install -g npm`
20+
* *Atom Editor*
21+
- available at [Atom.io](https://atom.io/)
22+
23+
### Install
24+
25+
You can install Atom packages inside of Atom through the following menus: "Atom -> Preferences -> Install", and search for "builder-coderoad".
26+
27+
You may also choose to install *Atom Shell Commands* under the "Atom" menu. Shell commands allow you to quickly install Atom packages from the command line, for example: `> apm install builder-coderoad`.
28+
29+
### Start
30+
31+
Toggle open *Builder-CodeRoad* using the *Packages* menu or press *ctrl-alt-9*.

_posts/docs/2016-01-02-development.md renamed to _posts/builder-coderoad/2016-01-03-development.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: Development
44
id: development
55
file: 2016-01-02-development.md
66
categories:
7-
- docs
7+
- builder-coderoad
88
---
99

1010
Get setup quickly with CodeRoad: either [clone a tutorial repo](https://git-scm.com/docs/git-clone) or use the *CodeRoad-CLI*.

_posts/docs/2016-01-01-installation.md

Lines changed: 0 additions & 65 deletions
This file was deleted.

_posts/docs/2016-01-03-tutorial.md renamed to _posts/docs/2016-01-01-tutorial.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
layout: docs
33
title: Tutorial Markdown
44
id: tutorial-md
5-
file: 2016-01-03-tutorial.md
5+
file: 2016-01-01-tutorial.md
66
categories:
77
- docs
88
---

_posts/docs/2016-01-04-coderoad-api.md renamed to _posts/docs/2016-01-02-coderoad-api.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
layout: docs
33
title: CodeRoad API
44
id: coderoad-API
5-
file: 2016-01-04-coderoad-api.md
5+
file: 2016-01-02-coderoad-api.md
66
categories:
77
- docs
88
---

_posts/docs/2016-01-05-tests.md renamed to _posts/docs/2016-01-03-tests.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
layout: docs
33
title: Unit Testing
44
id: tests
5-
file: 2016-01-05-tests.md
5+
file: 2016-01-03-tests.md
66
categories:
77
- docs
88
---

_posts/docs/2016-01-06-loaders.md renamed to _posts/docs/2016-01-04-loaders.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
layout: docs
33
title: Loaders
44
id: test-loaders
5-
file: 2016-01-06-loaders.md
5+
file: 2016-01-04-loaders.md
66
categories:
77
- docs
88
---

_posts/docs/2016-01-07-test-snippets.md renamed to _posts/docs/2016-01-05-test-snippets.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
layout: docs
33
title: Test Snippets
44
id: test-snippets
5-
file: 2016-01-07-test-snippets.md
5+
file: 2016-01-05-test-snippets.md
66
categories:
77
- docs
88
---

_posts/docs/2016-01-08-test-examples.md renamed to _posts/docs/2016-01-06-test-examples.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
layout: docs
33
title: Test Examples
44
id: test-examples
5-
file: 2016-01-08-test-examples.md
5+
file: 2016-01-06-test-examples.md
66
categories:
77
- docs
88
---

_posts/docs/2016-01-09-config.md renamed to _posts/docs/2016-01-07-config.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
layout: docs
33
title: Config
44
id: config
5-
file: 2016-01-09-config.md
5+
file: 2016-01-07-config.md
66
categories:
77
- docs
88
---

_posts/docs/2016-01-10-publish.md renamed to _posts/docs/2016-01-08-publish.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
layout: docs
33
title: Publishing
44
id: publish
5-
file: 2016-01-10-publish.md
5+
file: 2016-01-08-publish.md
66
categories:
77
- docs
88
---

_posts/docs/2016-01-11-test-runner.md renamed to _posts/docs/2016-01-09-test-runner.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
layout: docs
33
title: Test Runners
44
id: test-runners
5-
file: 2016-01-11-test-runner.md
5+
file: 2016-01-09-test-runner.md
66
categories:
77
- docs
88
---

_posts/docs/2016-01-12-roadmap.md renamed to _posts/docs/2016-01-10-roadmap.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,20 +2,19 @@
22
layout: docs
33
title: Roadmap
44
id: roadmap
5-
file: 2016-01-12-roadmap.md
5+
file: 2016-01-10-roadmap.md
66
categories:
77
- docs
88
---
99
CodeRoad will become more flexible & powerful with time.
1010

1111
### v1.0.0
12-
* Improved test coverage
1312
* More test runners for different programming languages
13+
* Solutions when stuck
1414

1515
### v2.0.0
1616
* User accounts
1717
* Tutorial ratings
18-
* `@use` API for page feature choices
18+
* Features API, to allow for video, quizzes, etc.
1919
* Optional page templates
20-
* Testing tool for viewing your development tutorial in real-time
2120
* Suggestions?
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
layout: tutorial
3+
title: Functional School
4+
file: 2016-01-01-functional-school.md
5+
language: JS
6+
url: https://github.com/coderoad/coderoad-functional-school
7+
categories:
8+
- tutorials
9+
---
10+
11+
A trip through functional programming in Javascript using common built-in Javascript array methods such as map & reduce.

_posts/tutorials/2016-01-02-es2015.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
layout: tutorial
3+
title: ES2015
4+
file: 2016-01-02-es2015.md
5+
language: JS
6+
url: https://github.com/shmck/coderoad-es2015
7+
categories:
8+
- tutorials
9+
---
10+
11+
Practice refactoring with ES2015 features.

atom-coderoad.html

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,18 @@
44
tagline: Play Interactive Tutorials
55
---
66

7-
<h3>Atom-CodeRoad</h3>
8-
<p>Coming soon...</p>
9-
10-
<ul>
11-
<li>Setup<li>
12-
<li>
7+
{% for post in site.categories.atom-coderoad reversed %}
8+
<br />
9+
<br />
10+
<section id="{{ post.id }}">
11+
<h2>{{ post.title }}</h2>
12+
<div>{{ post.content }}</div>
13+
<br>
14+
<a class="button" href="https://github.com/coderoad/coderoad.github.io/edit/master/_posts/docs/{{post.file}}">
15+
<i class="fa fa-pencil fa-fw"></i>
16+
<span class="network-name">
17+
Edit {{post.title}} Docs
18+
</span>
19+
</a>
20+
</section>
21+
{% endfor %}

builder-coderoad.html

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,27 @@
44
tagline: Create Interactive Tutorials
55
---
66

7-
<h3>Builder-CodeRoad</h3>
8-
<p>Coming soon...</p>
9-
7+
{% for post in site.categories.builder-coderoad reversed %}
8+
<br />
9+
<br />
10+
<section id="{{ post.id }}">
11+
<h2>{{ post.title }}</h2>
12+
<div>{{ post.content }}</div>
13+
<br>
14+
<a class="button" href="https://github.com/coderoad/coderoad.github.io/edit/master/_posts/docs/{{post.file}}">
15+
<i class="fa fa-pencil fa-fw"></i>
16+
<span class="network-name">
17+
Edit {{post.title}} Docs
18+
</span>
19+
</a>
20+
</section>
21+
{% endfor %}
22+
<!--
1023
<ul>
1124
<li>Installation</li>
1225
<li>Setup</li>
1326
<li>Visualize</li>
1427
<li>Tests</li>
1528
<li>Validation</li>
1629
<li>Publish</li>
17-
</ul>
30+
</ul> -->

0 commit comments

Comments
 (0)