- Notifications
You must be signed in to change notification settings - Fork167
💅 Clean and minimal JSDoc 3 Template / Theme
License
NotificationsYou must be signed in to change notification settings
nijikokun/minami
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
A clean, responsive documentation template theme for JSDoc 3.
- the Taffy Database library
- Underscore Template library
- Montserrat & Helvetica Neue
$ npm install --save-dev minami
Clone repository to your designatedjsdoc template directory, then:
$ jsdoc entry-file.js -t path/to/minami
In your projectspackage.json file add a generate script:
"scripts": {"generate-docs":"node_modules/.bin/jsdoc --configure .jsdoc.json --verbose"}
In your.jsdoc.json file, add a template option.
"opts": {"template":"node_modules/minami"}
{"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,"useLongnameInNav":false,"showInheritedInNav":true },"opts": {"destination":"./docs/","encoding":"utf8","private":true,"recurse":true,"template":"./node_modules/minami" }}Specifying a number for useLongnameInNav it will be the max number of path elements to show in nav (starting from Class).
Licensed under the Apache2 license.
About
💅 Clean and minimal JSDoc 3 Template / Theme
Resources
License
Uh oh!
There was an error while loading.Please reload this page.
Stars
Watchers
Forks
Packages0
No packages published
Uh oh!
There was an error while loading.Please reload this page.
Contributors10
Uh oh!
There was an error while loading.Please reload this page.