Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Commit8d147b0

Browse files
committed
progress with builder-coderoad docs
1 parentda89f51 commit8d147b0

File tree

12 files changed

+102
-34
lines changed

12 files changed

+102
-34
lines changed
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
title:Configuration
3+
link:config
4+
file:2016-01-03-config.md
5+
categories:
6+
-builder-coderoad
7+
---
8+
9+
Get setup quickly with CodeRoad: open the**builder-coderoad** plugin in an empty directory & click "start".
10+
11+
![Configuration Settings](../../images/builder/config.png){: .doc-image.lazy}
12+
13+
Filling out the first page should create:
14+
15+
* an example**tutorial.md**, which imports several tutorial files
16+
* an example**test** directory with a few example tests
17+
* a**package.json** configuration with some of the following settings:
18+
19+
```json
20+
{
21+
"name":"coderoad-$TUTORIAL-NAME$",
22+
"version":"0.1.0",
23+
"main":"coderoad.json",
24+
"keywords": [
25+
"coderoad",
26+
"tutorial"
27+
],
28+
"coderoad": {
29+
"dir":"tutorial",
30+
"testSuffix":".spec.js",
31+
"runner":"mocha-coderoad"
32+
}
33+
}
34+
```
Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
---
2+
title:Edit
3+
link:edit
4+
file:2016-01-04-edit.md
5+
categories:
6+
-builder-coderoad
7+
---
8+
9+
![Edit tutorial](../../images/builder/edit.png){: .image.lazy.right}
10+
11+
The project view can be seen from the "edit" page.
12+
13+
Changes will update whenever you**save** a file from the text editor.
14+
15+
Clicking on items in the view will move your cursor to the corresponding code in the text editor.
16+
17+
From the "edit" page, you can also view your tasks. Tasks are composed of:
18+
19+
#####description
20+
A summary of the task objective.
21+
22+
#####actions
23+
24+
Trigged changes in the users text editor, such as "open" a file or "insert" text. See the[coderoad-API docs](/tutorial-docs#coderoad-API) for more.
25+
26+
#####Hints
27+
28+
Helpful tips for the user.
29+
30+
#####Tests
31+
32+
Unit tests that verify task success and provide helpful failure messages. Learn more in the[test docs](/tutorial-docs#tests). These are marked by the file path, in the side example:`<> 01/01`. Clicking on tests will route to the test page.
33+
34+
#####onPageComplete
35+
36+
A message that will display when all page tasks are complete. It is located in the blue box at the bottom.
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title:Unit Tests
3+
link:test
4+
file:2016-01-05-test.md
5+
categories:
6+
-builder-coderoad
7+
---
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title:Validate
3+
link:validate
4+
file:2016-01-06-validate.md
5+
categories:
6+
-builder-coderoad
7+
---
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title:Publish
3+
link:publish
4+
file:2016-01-07-publish.md
5+
categories:
6+
-builder-coderoad
7+
---

‎_posts/builder-coderoad/2016-01-03-development.mdrenamed to‎_posts/tutorial-docs/2016-01-01-demo-tutorial.md

Lines changed: 5 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,12 @@
11
---
2-
title:Development
3-
link:development
4-
file:2016-01-02-development.md
2+
title:Demo Tutorial In Atom
3+
link:demo-tutorial
4+
file:2016-01-01-demo-tutorial.md
55
categories:
6-
-builder-coderoad
6+
-tutorial-docs
77
---
88

9-
Get setup quickly with CodeRoad: open the**builder-coderoad** plugin in an empty directory.
10-
11-
Filling out the first page should create:
12-
13-
* an example**tutorial.md**, which imports several tutorial files
14-
* an example**test** directory with a few example tests
15-
* a**package.json** configuration with some of the following settings:
16-
17-
```json
18-
{
19-
"name":"coderoad-$TUTORIAL-NAME$",
20-
"version":"0.1.0",
21-
"main":"coderoad.json",
22-
"keywords": [
23-
"coderoad",
24-
"tutorial"
25-
],
26-
"coderoad": {
27-
"dir":"tutorial",
28-
"testSuffix":".spec.js",
29-
"runner":"mocha-coderoad"
30-
}
31-
}
32-
```
33-
34-
We'll learn more about these configurations when it's time to[publish](/tutorial-docs#publish).
35-
36-
Changes will update whenever you save a file.
37-
38-
###Demo Your Tutorial
9+
###Demoing Your Tutorial
3910

4011
Open a new directory for demoing your tutorial. Setup a new NPM project file.
4112

‎_sass/_custom.scss

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,12 @@ a.smooth:hover {
1717
padding-left:30px;
1818
}
1919

20+
.doc-image {
21+
border-radius:3px;
22+
width:100%;
23+
max-width:1024px;
24+
}
25+
2026
.edit-docs {
2127
float:right;
2228
}

‎images/builder/config.png

43.1 KB
Loading

‎images/builder/edit.png

23.5 KB
Loading

‎images/builder/publish.png

26.6 KB
Loading

‎images/builder/test.png

9.38 KB
Loading

‎images/builder/validate.png

19 KB
Loading

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp