Nonlinear Performance Magnification

    jaguarjs-jsdoc

    1.1.0 • Public • Published

    Jaguar.js template for JSDoc 3

    Installation

    Install the template using NPM:

    npm install jaguarjs-jsdoc --save-dev

    Usage

    If you already have JSDoc system, you can use this project as JSDoc template. More information about JSDoc command-line arguments can be found here.

    jsdoc -c conf.json -R README.md

    conf.json

    You can set options for customizing your documentations. Notice the "template" field for setting the path to jaguarjs-jsdoc.

    "templates"{
        "applicationName": "Demo",
        "disqus": "",
        "googleAnalytics": "",
        "openGraph": {
            "title": "",
            "type": "website",
            "image": "",
            "site_name": "",
            "url": ""
        },
        "meta": {
            "title": "",
            "description": "",
            "keyword": ""
        },
        "linenums": true,
        "source": {
            "include": [
                "./src/"
            ],
            "includePattern": ".+\\.js(doc)?$",
            "excludePattern": "(^|\\/|\\\\)_"
        },
        "opts": {
            "encoding": "utf8",
            "recurse": true,
            "private": false,
            "lenient": true,
            "destination": "./docs",
            "template": "./node_modules/jaguarjs-jsdoc"
        }
    }

    License

    This project under the MIT License. and this project refered by default template for JSDoc 3.

    Install

    npm i jaguarjs-jsdoc

    DownloadsWeekly Downloads

    1,213

    Version

    1.1.0

    License

    MIT

    Last publish

    Collaborators

    • bigtimebuddy
    • joechamm