diff options
Diffstat (limited to 'support/jsdoc/theme/README.md')
| -rw-r--r-- | support/jsdoc/theme/README.md | 77 |
1 files changed, 77 insertions, 0 deletions
diff --git a/support/jsdoc/theme/README.md b/support/jsdoc/theme/README.md new file mode 100644 index 0000000..5eea506 --- /dev/null +++ b/support/jsdoc/theme/README.md @@ -0,0 +1,77 @@ +# Minami + +A clean, responsive documentation template theme for JSDoc 3. + + + +## Uses + +- [the Taffy Database library](http://taffydb.com/) +- [Underscore Template library](http://documentcloud.github.com/underscore/#template) +- [Montserrat](http://www.google.com/fonts/specimen/Monsterrat) & Helvetica Neue + +## Install + +```bash +$ npm install --save-dev minami +``` + +## Usage + +Clone repository to your designated `jsdoc` template directory, then: + +```bash +$ jsdoc entry-file.js -t path/to/minami +``` + +### Node.js Dependency + +In your projects `package.json` file add a generate script: + +```json +"script": { + "generate-docs": "node_modules/.bin/jsdoc --configure .jsdoc.json --verbose" +} +``` + +In your `.jsdoc.json` file, add a template option. + +```json +"opts": { + "template": "node_modules/minami" +} +``` + +### Example JSDoc Config + +```json +{ + "tags": { + "allowUnknownTags": true, + "dictionaries": ["jsdoc"] + }, + "source": { + "include": ["lib", "package.json", "README.md"], + "includePattern": ".js$", + "excludePattern": "(node_modules/|docs)" + }, + "plugins": [ + "plugins/markdown" + ], + "templates": { + "cleverLinks": false, + "monospaceLinks": true + }, + "opts": { + "destination": "./docs/", + "encoding": "utf8", + "private": true, + "recurse": true, + "template": "./node_modules/minami" + } +} +``` + +## License + +Licensed under the Apache2 license.
\ No newline at end of file |