Namis
A clean, responsive documentation template theme for JSDoc 3, based on Minami
Uses
- the Taffy Database library
- Underscore Template library
- Montserrat & Helvetica Neue
Live examples
What's new
- Implements a search engine
- Makes a more themeable template based on Minami, all you need to do is edit the custom.css file
- Uses more attractive jQuery scroll plugin named NiceScroll
- Improves color scheme and UI
Install
$ npm install --save-dev namis
Usage
Clone repository to your designated jsdoc
template directory, then:
$ jsdoc entry-file.js -t path/to/namis
Node.js Dependency
In your projects package.json
file add a generate script:
"script":
In your .jsdoc.json
file, add a template option.
"opts":
Example JSDoc Config
Example can be found on root folder of this package named jsdoc.json:
License
Licensed under the Apache2 license.
Contribution
Here is some simple steps
-
Fork, then clone the repo at git@github.com:your-username/namis.git
-
Push to your fork and submit a pull request
-
Write a good commit message
Enjoy.