Package Exports

docdash
docdash/package.json

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (docdash) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Docdash

A clean, responsive documentation template theme for JSDoc 3.

docdash-screenshot

docdash-screenshot-2

Install

$ npm install --save-dev docdash

Simple usage with cli

Clone repository to your designated jsdoc template directory, then:

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

Usage with build process

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

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

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

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

Example `.jsdoc.json`

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

Thanks

Thanks to lodash and minami.

License

Licensed under MIT license (see license).

docdash