Skip to content

Commit ca1c986

Browse files
committed
edit docs
1 parent 7352d65 commit ca1c986

9 files changed

+17
-1
lines changed

_includes/docs/docs.html

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@ <h1 id="overview" class="page-header">Overview</h1>
2222
<section id="{{ post.id }}">
2323
<h2 class="section-heading">{{ post.title }}</h2>
2424
<div class="lead">{{ post.content }}</div>
25+
<br>
26+
<a href="https://github.com/coderoad/coderoad.github.io/edit/master/_posts/{{ post.file}}" class="btn btn-default btn-xs"><i class="fa fa-pencil fa-fw"></i> <span class="network-name"> Edit {{post.title}} Docs</span></a>
2527
</section>
2628
<br> {% endfor %}
2729
</section>

_includes/docs/side-nav.html

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,17 @@
1313
</a>
1414
</li>
1515
{% endfor %}
16+
1617
</ul>
18+
<a class="page-scroll back-to-top" href="https://github.com/coderoad/coderoad.github.io/issues">
19+
<i class="fa fa-question"></i> Questions or Issues
20+
</a>
1721
<a class="page-scroll back-to-top" href="#top">
1822
<i class="glyphicon glyphicon-chevron-up"></i> Back to top
1923
</a>
24+
25+
26+
2027
</div>
2128

2229
</div>

_posts/2016-01-01-installation.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
layout: docs
33
title: Installation
44
id: install
5+
file: 2016-01-01-installation.md
56
---
67

78
To build a tutorial with CodeRoad, you'll need to install both **Atom-CodeRoad** & the **CodeRoad-CLI**.

_posts/2016-01-02-development.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
layout: docs
33
title: Development
44
id: development
5+
file: 2016-01-02-development.md
56
---
67

78
### Create

_posts/2016-01-03-tutorial.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
layout: docs
33
title: Tutorial File
44
id: tutorial
5+
file: 2016-01-03-tutorial.md
56
---
67
CodeRoad tutorials are written in Github Flavored Markdown, then parsed into a *coderoad.json* file when you run `> coderoad build`.
78

_posts/2016-01-04-coderoad-api.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
layout: docs
33
title: CodeRoad API
44
id: coderoad-API
5+
file: 2016-01-04-coderoad-api.md
56
---
67

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

_posts/2016-01-05-tests.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,10 @@
22
layout: docs
33
title: Unit Tests
44
id: tests
5+
file: 2016-01-05-tests.md
56
---
67

7-
Unit tests are used to determine the
8+
Unit tests are used to determine the
89

910
### Loading the User File
1011

_posts/2016-01-06-testRunner.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
layout: docs
33
title: Test Runner
44
id: test-runner
5+
file: 2016-01-06-testRunner.md
56
---
67
coming soon
78

_posts/2016-01-07-publish.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
layout: docs
33
title: Publish
44
id: publish
5+
file: 2016-01-07-publish.md
56
---
67

78
### Completing your `package.json`

0 commit comments

Comments
 (0)