Skip to content
forked from clenemt/docdash

⚡ Lodash inspired JSDoc 3 template / theme

License

Notifications You must be signed in to change notification settings

pleymor/docdash

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

11 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Docdash

npm package license

A clean, responsive documentation template theme for JSDoc 3.

docdash-screenshot

docdash-screenshot-2

Example

See http://clenemt.github.io/docdash/ for a sample demo. 🚀

Install

$ npm install docdash

Usage

Clone repository to your designated jsdoc template directory, then:

$ jsdoc entry-file.js -t path/to/docdash

Usage (npm)

In your projects package.json file add a new script:

"script": {
  "generate-docs": "node_modules/.bin/jsdoc -c jsdoc.json"
}

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

"opts": {
  "template": "node_modules/docdash"
}

Sample jsdoc.json

See the config file for the fixtures or the sample below.

{
    "tags": {
        "allowUnknownTags": false
    },
    "source": {
        "include": "../js",
        "includePattern": ".js$",
        "excludePattern": "(node_modules/|docs)"
    },
    "plugins": [
        "plugins/markdown"
    ],
    "opts": {
        "template": "assets/template/docdash/",
        "encoding": "utf8",
        "destination": "docs/",
        "recurse": true,
        "verbose": true
    },
    "templates": {
        "cleverLinks": false,
        "monospaceLinks": false
    }
}

Thanks

Thanks to lodash and minami.

License

Licensed under the Apache License, version 2.0. (see Apache-2.0).

About

⚡ Lodash inspired JSDoc 3 template / theme

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 91.0%
  • CSS 9.0%