Skip to content

Commit 21af21d

Browse files
committed
docs continued
1 parent e781c87 commit 21af21d

File tree

9 files changed

+78
-18
lines changed

9 files changed

+78
-18
lines changed

_includes/docs/docs.html

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,21 +10,26 @@
1010
<h1 id="overview" class="page-header">Overview</h1>
1111

1212
<blockquote>
13-
Docs are under construction
13+
CodeRoad aims to make building & sharing interactive tutorials as easy as possible.
1414
</blockquote>
15-
<br>
16-
{% for post in site.posts reversed %}
15+
16+
<div class="lead">
17+
For a quick overview of how everything comes together&nbsp;&nbsp;&nbsp;
18+
<a href="/build" class="btn btn-default btn-lg"><i class="fa fa-road fa-fw"></i> <span class="network-name">Read this</span></a>
19+
20+
</div>
21+
22+
<br> {% for post in site.posts reversed %}
1723

1824
<section id="{{ post.id }}">
1925
<h2 class="section-heading">{{ post.title }}</h2>
2026
<div class="lead">{{ post.content }}</div>
2127
</section>
22-
<br>
23-
{% endfor %}
28+
<br> {% endfor %}
2429
</section>
2530
</div>
2631

27-
{% include docs/side-nav.html %}
32+
{% include docs/side-nav.html %}
2833

2934
</div>
3035
</section>

_includes/docs/header.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
<div class="col-lg-12">
99
<div class="intro-message">
1010
<h1>CodeRoad</h1>
11-
<h3>Documentation</h3>
11+
<h3>Docs</h3>
1212
</div>
1313

1414
</div>

_posts/2016-01-03-tutorial.md

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,24 @@
11
---
22
layout: docs
3-
title: Tutorial
3+
title: Tutorial File
44
id: tutorial
55
---
6-
coming soon
6+
Description
7+
8+
### Markdown
9+
10+
### Syntax
11+
12+
#### @import
13+
14+
#### @test
15+
16+
#### @hint
17+
18+
#### @action
19+
20+
* open
21+
22+
* set
23+
24+
* insert

_posts/2016-01-04-tests.md

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,26 @@
11
---
22
layout: docs
3-
title: Writing Tests
3+
title: Unit Tests
44
id: tests
55
---
66

7-
coming soon
7+
Description
8+
9+
### Loading the User File
10+
11+
### Data Files
12+
13+
### Mocha-CodeRoad
14+
15+
### Test Examples
16+
17+
* exists
18+
* type
19+
* params
20+
* equals
21+
* deep equals
22+
* regex
23+
* property
24+
* spies
25+
26+
### Future Testing Tool

_posts/2016-01-05-testRunner.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,8 @@ layout: docs
33
title: Test Runner
44
id: test-runner
55
---
6-
76
coming soon
7+
8+
### Mocha-CodeRoad
9+
10+
### How to Build a Test Runner

_posts/2016-01-06-cli.md

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

_posts/2016-01-06-publish.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
layout: docs
3+
title: Publish
4+
id: publish
5+
---
6+
7+
### Completing your `package.json`
8+
9+
### Versioning
10+
11+
### Publishing to NPM

_posts/2016-01-07-collaborating.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
layout: docs
3+
title: Collaborating
4+
id: collaborate
5+
---

css/docs.min.css

Lines changed: 5 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)