jsdoc-conf.json

{
    "tags": {
        "allowUnknownTags": true,
        "dictionaries": ["jsdoc","closure"]
    },
    "source": {
        "includePattern": ".+\\.js(doc)?$",
        "excludePattern": "(^|\\/|\\\\)_|(^|\\/|\\\\)node_modules|(^|\\/|\\\\)dist"
    },
    "plugins": [
        "plugins/markdown",
        "./jsdoc-plugin-hia"
    ],
    "markdown": {
        "hardwrap": true,
        "idInHeadings":true,
        "tags": ["file","overview","property","todo"]
    },
    "templates": {
        "cleverLinks": false,
        "monospaceLinks": false
    },
    "opts": {
        "template"    : "./node_modules/docdash-hia",
        "encoding"    : "utf8"                      ,
        "destination" : "./api/"                    ,
        "recurse"     : true                        ,
        "//tutorials"   : "./doc/"                    ,
        "readme"   : "./README.md"                  ,
        "access "     : "all"                       ,
        "private"     : true                        ,

        "@todo ":"调整一些设定项比如站点相关设置等",
        "docdash": {
            "static": true,
            "sort":  false,
            "sectionOrder": [
                "Classes",
                "Modules",
                "Externals",
                "Events",
                "Namespaces",
                "Mixins",
                "Tutorials",
                "Interfaces"
            ],
            "openGraph": {
                "title": "jsdoc-plugin-hia",
                "type": "website",
                "image": "",
                "site_name": "jsdoc-plugin-hia",
                "url": ""
            },
            "meta": {
                "title": "jsdoc-plugin-hia",
                "description": "jsdoc-plugin-hia",
                "keyword": "jsdoc-plugin-hia"
            },
            "search": true,
            "collapse": false,
            "typedefs": true
        }

    }
}