A clean, responsive documentation template theme for JSDoc 3, based on LatoDoc
$ npm install --save-dev postman-jsdoc-themeClone repository to your designated jsdoc template directory, then:
$ jsdoc entry-file.js -t path/to/postman-jsdoc-themeOptionally, provide a package version on the command line, which will be rendered into the final documentation
$ jsdoc entry-file.js -t path/to/postman-jsdoc-theme --query 'pkgVersion=2.3.0'In your projects package.json file add a generate script:
"script": {
"generate-docs": "node_modules/.bin/jsdoc --configure .jsdoc.json --verbose"
}In your .jsdoc.json file, add a template option.
"opts": {
"template": "node_modules/postman-jsdoc-theme"
}{
"tags": {
"allowUnknownTags": true,
"dictionaries": ["jsdoc"]
},
"source": {
"include": ["lib", "package.json", "README.md"],
"includePattern": ".js$",
"excludePattern": "(node_modules/|docs)"
},
"plugins": [
"plugins/markdown"
],
"templates": {
"cleverLinks": true,
"monospaceLinks": true
},
"opts": {
"destination": "./docs/",
"encoding": "utf8",
"private": true,
"recurse": true,
"template": "./node_modules/postman-jsdoc-theme"
}
}Licensed under the MIT license.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent