No Partying Mariachis

    @edwellbrook/minami

    1.3.3 • Public • Published

    Minami

    A clean, responsive documentation template theme for JSDoc 3.

    Minami Screenshot

    Uses

    Install

    $ npm install --save-dev @edwellbrook/minami

    Usage

    Clone repository to your designated jsdoc template directory, then:

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

    Node.js Dependency

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

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

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

    "opts": {
      "template": "node_modules/@edwellbrook/minami"
    }

    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": false,
            "monospaceLinks": true,
            "useLongnameInNav": false
        },
        "opts": {
            "destination": "./docs/",
            "encoding": "utf8",
            "private": true,
            "recurse": true,
            "template": "./node_modules/@edwellbrook/minami"
        }
    }

    Specifying a number for useLongnameInNav it will be the max number of path elements to show in nav (starting from Class).

    License

    The MIT License (MIT)

    Keywords

    none

    Install

    npm i @edwellbrook/minami

    DownloadsWeekly Downloads

    0

    Version

    1.3.3

    License

    none

    Unpacked Size

    64.6 kB

    Total Files

    24

    Last publish

    Collaborators

    • edwellbrook