docma.json

{
    "debug": 5,
    "jsdoc": {
        "encoding": "utf8",
        "recurse": false,
        "pedantic": false,
        "access": [
            "public"
        ],
        "package": null,
        "module": true,
        "undocumented": false,
        "undescribed": false,
        "ignored": false,
        "hierarchy": true,
        "sort": "grouped",
        "relativePath": null,
        "filter": "^((?!EventEmitter).)*$",
        "allowUnknownTags": true,
        "plugins": [],
        "includePattern": ".+\\.js(doc|x)?$"
    },
    "markdown": {
        "gfm": true,
        "tables": true,
        "breaks": false,
        "pedantic": false,
        "sanitize": false,
        "smartLists": true,
        "smartypants": false,
        "tasks": true,
        "emoji": true
    },
    "app": {
        "title": "TaskTimer",
        "meta": null,
        "base": "/tasktimer",
        "entrance": "content:guide",
        "routing": "path",
        "server": "github",
        "favicon": "./design/favicon.ico"
    },
    "template": {
        "path": "zebra",
        "options": {
            "title": {
                "label": "TaskTimer",
                "href": "/tasktimer/"
            },
            "logo": "img/tasktimer-logo-sm.png", // URL String or { dark: String, light: String }
            "sidebar": {
                "enabled": true,
                "outline": "tree",          // "flat" | "tree"
                "collapsed": false,
                "toolbar": true,
                "itemsFolded": false,
                "itemsOverflow": "crop",    // "crop" | "shrink"
                "badges": true,             // true | false | <string-value>
                "search": true,
                "animations": true
            },
            "symbols": {
                "autoLink": true,           // "internal" | "external" | true (both)
                "params": "list",           // "list" | "table"
                "enums": "list",            // "list" | "table"
                "props": "list",            // "list" | "table"
                "meta": false
            },
            "contentView": {
                "bookmarks": "h1,h2,h3"
            },
            "navbar": {
                "enabled": true,
                "fixed": true,
                "dark": false,
                "animations": true,
                "menu": [
                    {
                        "label": "Guide",
                        "href": "./"
                    },
                    {
                        "label": "API Reference",
                        "href": "./api"
                    },
                    {
                        "iconClass": "fa-lg fb-github",
                        "label": "GitHub",
                        "href": "https://github.com/onury/tasktimer",
                        "target": "_blank"
                    }
                ]
            }
        }
    },
    "src": [
        "./lib/tasktimer.js",
        "./docs/interfaces.jsdoc",
        {
            "guide": "./README.md"
        },
        "./CHANGELOG.md"
    ],
    "assets": {
        "/img": [
            "./design/tasktimer-logo-sm.png"
        ]
    },
    "dest": "../onury.github.io/tasktimer",
    "clean": true
}