Rev 1221 | Details | Compare with Previous | Last modification | View Log | RSS feed
| Rev | Author | Line No. | Line |
|---|---|---|---|
| 1185 | werner | 1 | yuidoc-bootstrap-theme |
| 2 | ====================== |
||
| 3 | |||
| 4 | A revamped yuidoc theme with bootstrap. |
||
| 5 | |||
| 6 | Grab from npm via: |
||
| 7 | |||
| 8 | npm install yuidoc-bootstrap-theme |
||
| 9 | |||
| 10 | https://www.npmjs.org/package/yuidoc-bootstrap-theme |
||
| 11 | |||
| 12 | When running yuidoc from command line: |
||
| 13 | -t : themedir |
||
| 14 | -H : helper js file |
||
| 15 | |||
| 16 | Ex. |
||
| 17 | |||
| 18 | yuidoc -t _location_/yuidoc-bootstrap-theme -H _location_/yuidoc-bootstrap-theme/helpers/helpers.js |
||
| 19 | |||
| 20 | When running with grunt it is best to use this as a submodule. |
||
| 21 | |||
| 22 | Then under yuidoc.json options add: |
||
| 23 | |||
| 24 | "themedir" : _location_/yuidoc-bootstrap-theme, |
||
| 25 | "helpers" : [ _location_/yuidoc-bootstrap-theme/helpers/helpers.js ] |
||
| 26 | |||
| 27 | Ex. |
||
| 28 | |||
| 29 | { |
||
| 30 | "name": "Example", |
||
| 31 | "url": "www.example.com", |
||
| 32 | "version": "0.1.0", |
||
| 33 | "options": { |
||
| 34 | "paths": "_location to parse_", |
||
| 35 | "outdir": "build/docs", |
||
| 36 | "exclude": "lib,docs,build", |
||
| 37 | "themedir": "_location_/yuidoc-bootstrap-theme", |
||
| 38 | "helpers": ["_location_/yuidoc-bootstrap-theme/helpers/helpers.js"] |
||
| 39 | } |
||
| 40 | } |
||
| 41 |