Skip to content

Commit 9865569

Browse files
committed
Update docs template
1 parent 09dfada commit 9865569

File tree

2 files changed

+123
-114
lines changed

2 files changed

+123
-114
lines changed

resources/docstrap-master/README.md

+12-9
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,14 @@ A modified [DocStrap](https://github.com/docstrap/docstrap) template for [JSDoc3
55
## Command Line Example
66

77
```bash
8-
jsdoc -c path/to/conf.json -t ./node_modules/ink-docstrap/template -R README.md -r .
8+
jsdoc -c path/to/config.json -t path/to/tomorrow/template -R README.md -r .
99
```
1010

11-
- The `-c` sets the config, and the docstrap README does talk about the options you can put in templates that docstrap is supposed to look for.
12-
- The `-t` sets the template. This is the option you need to set to get the docstrap template to be used.
13-
- The `-R` sets a markdown file to be the front page of the documentation.
14-
- The `-r` tells jsdoc to run recursively.
15-
- The `.` says from current directory.
11+
- `-c` config file
12+
- `-t` template directory
13+
- `-R` README page
14+
- `-r` recursive
15+
- `.` target (current directory)
1616

1717
## Configuring the template
1818

@@ -65,6 +65,9 @@ npm install
6565
# List tasks
6666
grunt --help
6767

68+
# Watch and build CSS & JS
69+
grunt watch
70+
6871
# Build CSS from LESS
6972
grunt less
7073

@@ -176,11 +179,11 @@ grunt examples
176179
- Bump to follow semver (initial development is well and truly over)
177180
- Corrected list of themes
178181
- Added Search
179-
- Remove highlightTutorialCode option - it didn't work
182+
- Remove highlightTutorialCode option - it didnt work
180183

181184
## 0.5.4
182185

183-
- Fix layout glitch on the bottom of code samples
186+
- Fix layout glitch on hte bottom of code samples
184187
- Support for specifying the language for fenced code blocks in the normal way
185188
- Fix the active item in some themes, which was missing a background
186189
- Tables get marked as tables
@@ -265,7 +268,7 @@ grunt examples
265268

266269
## 0.2.0
267270

268-
- Added jump to source linenumbers - still a problem scrolling with fixed header
271+
- Added jump to source linenumers - still a problem scrolling with fixed header
269272
- changed syntax highlighter to [sunlight](http://sunlightjs.com/)
270273
- Modify incoming bootswatch files to make font calls without protocol.
271274

0 commit comments

Comments
 (0)