@@ -5,14 +5,14 @@ A modified [DocStrap](https://github.com/docstrap/docstrap) template for [JSDoc3
5
5
## Command Line Example
6
6
7
7
``` 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 .
9
9
```
10
10
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)
16
16
17
17
## Configuring the template
18
18
@@ -65,6 +65,9 @@ npm install
65
65
# List tasks
66
66
grunt --help
67
67
68
+ # Watch and build CSS & JS
69
+ grunt watch
70
+
68
71
# Build CSS from LESS
69
72
grunt less
70
73
@@ -176,11 +179,11 @@ grunt examples
176
179
- Bump to follow semver (initial development is well and truly over)
177
180
- Corrected list of themes
178
181
- Added Search
179
- - Remove highlightTutorialCode option - it didn't work
182
+ - Remove highlightTutorialCode option - it didnt work
180
183
181
184
## 0.5.4
182
185
183
- - Fix layout glitch on the bottom of code samples
186
+ - Fix layout glitch on hte bottom of code samples
184
187
- Support for specifying the language for fenced code blocks in the normal way
185
188
- Fix the active item in some themes, which was missing a background
186
189
- Tables get marked as tables
@@ -265,7 +268,7 @@ grunt examples
265
268
266
269
## 0.2.0
267
270
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
269
272
- changed syntax highlighter to [ sunlight] ( http://sunlightjs.com/ )
270
273
- Modify incoming bootswatch files to make font calls without protocol.
271
274
0 commit comments