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

Commit3249498

Browse files
committed
move docs into organized markdown
1 parentd8ccec5 commit3249498

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

0 commit comments

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