minimal-jsdoc
v0.1.0
Published
Minimal template for JSDoc 3
Downloads
8
Readme
Minimal template for JSDoc 3 (Beta)
A minimal template for creating clean documentation for one-namespace libraries.
See a demo.
This is still a beta and hasn't been heavily field tested. The code is pretty dirty right now due to pure laziness. This should only be used if your library contains one name-space. Not sure what would happen if you added more that one. Haha.
Usage
npm install --save-dev minimal-jsdoc
$ jsdoc -t .node_modules/minimal-jsdoc -c `configuration file` `source files` --readme `README.md file`
conf.json
You can set options for customizing your documentations.
"templates": {
"version": "1.0.0",
"applicationName": "Demo",
"disqus": "",
"googleAnalytics": "",
"openGraph": {
"title": "",
"type": "website",
"image": "",
"site_name": "",
"url": ""
},
"meta": {
"title": "",
"description": "",
"keyword": ""
},
"linenums": true
}
Credits
Many credits go to davidshimjs as this is a fork of davidshimjs/jaguarjs-jsdoc
License
This project under the MIT License. and this project refered by default template for JSDoc 3.