Skip to content

Commit 6a08f18

Browse files
committed
update docs
1 parent d2eb3bb commit 6a08f18

File tree

5 files changed

+16
-10
lines changed

5 files changed

+16
-10
lines changed

_posts/tutorial-docs/2016-01-02-coderoad-api.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@ Defaults for loading tests are specified in the tutorial *package.json* file.
4242
```json
4343
{
4444
"config": {
45+
"language": "JS",
4546
"dir": "tutorial",
4647
"testSuffix": ".spec.js",
4748
"runner": "mocha-coderoad"

_posts/tutorial-docs/2016-01-03-tests.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ it('isn\'t a function')
3535
Use a **loader** to run the user saved file in the context of your file. Think of a loader as a way to place the file your testing inside of your test file. Loaders are written as comments.
3636

3737
```js
38-
// load('user-file.js')
38+
/// load('user-file.js')
3939
```
4040

4141
*Note: When using spies, stubs or mocks, initiate them above your loader call.*
@@ -55,10 +55,10 @@ var data = 42;
5555

5656
*test.spec.js*
5757
```
58-
// load('data/file.js', true)
59-
// load('user-file.js')
58+
/// load('data/file.js', true)
59+
/// load('user-file.js')
6060
61-
// tests here
61+
/* tests here */
6262
```
6363

6464
Users can access global data by name in their file.

_posts/tutorial-docs/2016-01-04-loaders.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Loaders are hidden behind comments, which may differ based on the programming la
1010

1111
##### JavaScript / TypeScript / JSX
1212

13-
`// load('file.js')`
13+
`/// load('file.js')`
1414

1515
##### Python
1616
`# load('file.py')`

_posts/tutorial-docs/2016-01-07-config.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,16 +10,21 @@ CodeRoad tutorial configurations can be set in the *package.json* config.
1010
```json
1111
{
1212
"config": {
13-
"dir": "tutorial",
14-
"testSuffix": ".spec.js",
15-
"runner": "mocha-coderoad",
16-
"edit": true
13+
"language": "JS",
14+
"dir": "tutorial",
15+
"testSuffix": ".spec.js",
16+
"runner": "mocha-coderoad",
17+
"edit": true
1718
}
1819
}
1920
```
2021

2122
This section will likely expand in the future. For now, let's go over some of the configurations.
2223

24+
#### language
25+
26+
The programming language being used (for example: "JS", "Python", etc.)
27+
2328
#### dir
2429

2530
The relative path to the unit test directory (from your tutorial directory). This makes writing unit tests paths easier.

_sass/_custom.scss

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ a.smooth:hover {
1919

2020
.doc-contents {
2121
padding: 20px 50px;
22-
background-color: _palette(border-bg);
22+
background-color: rgba(27,43,52, 0.05);
2323
border-radius: 3px;
2424
margin: 0 auto;
2525
max-width: 400px;

0 commit comments

Comments
 (0)