postmanlabs/postman-jsdoc-theme

Name: postman-jsdoc-theme

Owner: Postman

Description: A JSDoc Theme

Created: 2016-06-02 07:42:24.0

Updated: 2018-03-02 03:04:34.0

Pushed: 2017-06-21 09:54:40.0

Homepage: null

Size: 154

Language: JavaScript

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

Postman JSDoc3 Theme

A clean, responsive documentation template theme for JSDoc 3, based on LatoDoc

Install

m install --save-dev postman-jsdoc-theme

Usage

Clone repository to your designated jsdoc template directory, then:

doc 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

doc 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:

ipt": {
enerate-docs": "node_modules/.bin/jsdoc --configure .jsdoc.json --verbose"

In your .jsdoc.json file, add a template option.

s": {
emplate": "node_modules/postman-jsdoc-theme"

Example JSDoc Config

"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.