Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

    @rtsao/docdashpublic

    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
        }
    }

    Options

    Docdash supports the following options:

    {
        "docdash": {
            "static": [false|true],  // Display the static members inside the navbar
            "sort": [false|true]     // Sort the methods in the navbar
        }
    }

    Place them anywhere inside your jsdoc.json file.

    Thanks

    Thanks to lodash and minami.

    License

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

    install

    npm i @rtsao/docdash

    Downloadsweekly downloads

    0

    version

    0.4.2

    license

    Apache-2.0

    repository

    github.com

    last publish

    collaborators

    • avatar