Skip to content

Commit 284bea8

Browse files
committed
update coderoad api docs
1 parent ba84e3c commit 284bea8

File tree

3 files changed

+56
-42
lines changed

3 files changed

+56
-42
lines changed

_config.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ email: coderoadapp@gmail.com
88
author: Shawn McKay
99
description: > # "Free interactive coding tutorials inside of the Atom editor. Build your own tutorials
1010
using the coderoad-cli and tools developers already know: markdown and unit tests.
11-
atomVersion: 0.4.21
12-
cliVersion: 0.3.23
11+
atomVersion: 0.5.0
12+
cliVersion: 0.3.24
1313
video: DbLpdgrYVOU
1414

1515
# ----------------------- #

_includes/docs/docs.html

Lines changed: 35 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,39 @@
1-
<section id="docs">
2-
<div class="container bs-docs-container">
3-
<div class="row">
4-
5-
{% include docs/side-nav.html %}
6-
7-
<div class="col-md-9 col-xs-12" role="main">
8-
<section class="bs-docs-section">
9-
<h1 id="overview" class="page-header">Overview</h1>
10-
11-
<blockquote>
12-
CodeRoad aims to make building & sharing interactive coding tutorials as easy as possible.
13-
</blockquote>
14-
15-
<div class="lead">We hope to create fun and maintainable code tutorials that actually 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
16-
interactive coding tutorials built. That's where you come in.</div>
17-
18-
<a href="/build" class="btn btn-default btn-lg">
19-
<i class="fa fa-road fa-fw"></i>
20-
<span class="network-name">Read an Overview of Building a Tutorial</span>
21-
</a>
22-
23-
</section>
24-
25-
{% for post in site.posts reversed %}
26-
<section id="{{ post.id }}" class="bs-docs-section">
27-
<h2 class="section-heading">{{ post.title }}</h2>
28-
<div class="lead">{{ post.content }}</div>
29-
<br>
30-
<a href="https://github.com/coderoad/coderoad.github.io/edit/master/_posts/{{post.file}}" class="btn btn-default btn-xs">
31-
<i class="fa fa-pencil fa-fw"></i>
32-
<span class="network-name">
33-
Edit {{post.title}} Docs</span>
34-
</a>
35-
</section>
36-
<br>
37-
{% endfor %}
38-
</div>
1+
<section id="docs" class="container">
2+
<div class="row">
3+
4+
{% include docs/side-nav.html %}
5+
6+
<div class="col-md-9 col-xs-12" role="main">
7+
<section class="bs-docs-section">
8+
<h1 id="overview" class="page-header">Overview</h1>
9+
10+
<blockquote>
11+
CodeRoad aims to make building & sharing interactive coding tutorials as easy as possible.
12+
</blockquote>
13+
14+
<div class="lead">We hope to create fun and maintainable code tutorials that actually 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
15+
tutorials built. That's where you come in.</div>
3916

17+
<a href="/build" class="btn btn-default btn-lg">
18+
<i class="fa fa-road fa-fw"></i>
19+
<span class="network-name">Read an Overview of Building a Tutorial</span>
20+
</a>
21+
22+
</section>
23+
24+
{% for post in site.posts reversed %}
25+
<section id="{{ post.id }}" class="bs-docs-section">
26+
<h2 class="section-heading">{{ post.title }}</h2>
27+
<div class="lead">{{ post.content }}</div>
28+
<br>
29+
<a href="https://github.com/coderoad/coderoad.github.io/edit/master/_posts/{{post.file}}" class="btn btn-default btn-xs">
30+
<i class="fa fa-pencil fa-fw"></i>
31+
<span class="network-name">
32+
Edit {{post.title}} Docs</span>
33+
</a>
34+
</section>
35+
<br> {% endfor %}
4036
</div>
37+
4138
</div>
4239
</section>

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

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -118,6 +118,23 @@ Add text to the bottom of the active text editor.
118118
```))
119119
```
120120

121-
#### What's Next
121+
### `@onPageComplete`
122122

123-
More editor actions will be added to CodeRoad at a later date. These may include changing the cursor position, replacing content, decorating keywords, etc.
123+
An optional message that will appear when all of the tasks for a page are completed.
124+
125+
```markdown
126+
## Page 1
127+
Page 1 description
128+
129+
@onPageComplete('Next we'll look at page 2')
130+
```
131+
132+
### What's Next
133+
134+
Further editor actions will be added to CodeRoad. These may include:
135+
136+
* changing the cursor position
137+
* replacing content
138+
* decorating keywords
139+
140+
Feel free to suggest a feature.

0 commit comments

Comments
 (0)