jsdoc.conf.json

{
    "tags": {
        "allowUnknownTags": true,
        "dictionaries": [
            "jsdoc"
        ]
    },
    "source": {
        "include": [
            "src"
        ],
        "includePattern": ".js$",
        "excludePattern": "(node_modules/|docs)"
    },
    "plugins": [
        "plugins/markdown"
    ],
    "templates": {
        "cleverLinks": false,
        "monospaceLinks": true,
        "useLongnameInNav": true,
        "showInheritedInNav": true,
        "default": {
            "includeDate": false,
            "staticFiles": {
                "include": ["./docs/static"]
            }
        }
    },
    "opts": {
        "destination": "./docs/api",
        "encoding": "utf8",
        "recurse": true,
        "hierarchy": true,
        "readme": "README.md",
        "tutorials": "./docs/tutorials",
        "template": "node_modules/clean-jsdoc-theme",
        "theme_opts": {
            "theme": "dark",
            "title": "<img src='bsp-logo.png'/>",
            "footer": "",
            "search": {
                "shouldSort": true,
                "threshold": 0.4,
                "location": 0,
                "distance": 100,
                "maxPatternLength": 32,
                "minMatchCharLength": 1
            },
            "menu": [
                {
                    "title": "Github",
                    "link": "https://github.com/bbc/bigscreen-player",
                    "target": "_blank"
                },
                {
                    "title": "NPM",
                    "link": "https://www.npmjs.com/package/bigscreen-player",
                    "target": "_blank"
                }
            ],
            "meta": [
                {
                    "name": "description",
                    "content": "Simplified media playback for bigscreen devices"
                }
            ]
        }
    }
}