musicvis-lib/jsdoc.conf.json

Music analysis and visualization library

{
    "plugins": [],
    "recurseDepth": 10,
    "source": {
        "include": [
            "src/",
            "README.md"
        ],
        "includePattern": ".+\\.js(doc|x)?$",
        "excludePattern": "(^|\\/|\\\\)_"
    },
    "sourceType": "module",
    "tags": {
        "allowUnknownTags": true,
        "dictionaries": [
            "jsdoc",
            "closure"
        ]
    },
    "templates": {
        "cleverLinks": false,
        "monospaceLinks": true,
        "useLongnameInNav": false,
        "showInheritedInNav": true,
        "default": {
            "includeDate": false
        }
    },
    "opts": {
        "destination": "./docs/",
        "encoding": "utf8",
        "private": true,
        "recurse": true,
        "template": "./node_modules/clean-jsdoc-theme",
        "verbose": true,
        "theme_opts": {
            "theme": "dark",
            "title": "musicvis-lib",
            "menu": [
                {
                    "title": "Website",
                    "link": "https://fheyen.github.io/musicvis-lib",
                    "target": "_blank"
                },
                {
                    "title": "Github",
                    "link": "https://github.com/fheyen/musicvis-lib",
                    "target": "_blank"
                }
            ],
            "create_style": "h1.page-title::after, article h1::after{background: none} body, section, article{background: #282828} span.pun {color: #fff} span.lit {color: #cfe} span.com {color: #080} span.kwd {color:marine} span.pln {color: #8df} span.typ {color: #0c8} span.str{color: #c96}"
        }
    }
}