https://github.com/postmanlabs/postman-jsdoc-theme
A JSDoc Theme
https://github.com/postmanlabs/postman-jsdoc-theme
Last synced: 3 months ago
JSON representation
A JSDoc Theme
- Host: GitHub
- URL: https://github.com/postmanlabs/postman-jsdoc-theme
- Owner: postmanlabs
- License: mit
- Created: 2016-06-02T07:42:24.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2019-10-18T00:46:03.000Z (about 6 years ago)
- Last Synced: 2025-01-26T13:38:39.922Z (12 months ago)
- Language: JavaScript
- Size: 150 KB
- Stars: 13
- Watchers: 14
- Forks: 7
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Postman JSDoc3 Theme
A clean, responsive documentation template theme for JSDoc 3, based on [LatoDoc](https://github.com/smeijer/latodoc)
## Install
```bash
$ npm install --save-dev postman-jsdoc-theme
```
## Usage
Clone repository to your designated `jsdoc` template directory, then:
```bash
$ jsdoc entry-file.js -t path/to/postman-jsdoc-theme
```
Optionally, provide a package version on the command line, which will be rendered into the final documentation
```bash
$ jsdoc entry-file.js -t path/to/postman-jsdoc-theme --query 'pkgVersion=2.3.0'
```
### 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/postman-jsdoc-theme"
}
```
### 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": true,
"monospaceLinks": true
},
"opts": {
"destination": "./docs/",
"encoding": "utf8",
"private": true,
"recurse": true,
"template": "./node_modules/postman-jsdoc-theme"
}
}
```
## License
Licensed under the MIT license.