Skip to content

Commit ceecdc2

Browse files
committed
initial markdown and config
1 parent 4ef2116 commit ceecdc2

File tree

3 files changed

+41
-0
lines changed

3 files changed

+41
-0
lines changed

Diff for: README.md

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# CodeRoad Documentation
2+
3+
See more details at https://github.coderoad.io.
4+
5+
## Tutorial Code
6+
7+
See the tutorial code on the v0.1.0 branch.
8+
9+
## Build Tutorial
10+
11+
Run the CodeRoad builder targetting the `TUTORIAL.md` to generate the `config.json`.
12+
13+
You can run the tutorial by loading the config.json in the CodeRoad extension.

Diff for: TUTORIAL.md

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Title of Tutorial
2+
3+
> A description of the tutorial
4+
5+
```config
6+
config:
7+
testRunner:
8+
command: npm run programmatic-test
9+
path: .coderoad
10+
actions:
11+
commits:
12+
- '1728434'
13+
commands:
14+
- npm install
15+
repo:
16+
uri: https://github.com/coderoad/starter-js-mocha
17+
branch: v0.1.0
18+
dependencies:
19+
- name: node
20+
version: >=10
21+
```
22+
23+
## Level 1 Title
24+
25+
> Introduction to the tutorial
26+
27+
Some write up here to introduce what the tutorial is about.

Diff for: config.json

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{}

0 commit comments

Comments
 (0)