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": "alphabetic",
        "relativePath": null,
        "filter": null,
        "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": "Notation",
        "meta": null,
        "base": "/notation",
        "entrance": "content:guide",
        "routing": "path",
        "server": "github"
    },
    "template": {
        "path": "zebra",
        "options": {
            "title": {
                "label": "Notation",
                "href": "/notation/"
            },
            "logo": null,                   // 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": "guide/"
                    },
                    {
                        "label": "API Reference",
                        "href": "api/"
                    },
                    {
                        "label": "Releases",
                        "items": [
                            // {
                            //     "label": "Link via CDNJS",
                            //     "href": "https://cdnjs.com/libraries/notation",
                            //     "target": "_blank"
                            // },
                            // { "separator": true },
                            { "label": "<code>npm i notation</code>" },
                            { "separator": true },
                            {
                                "label": "Download as Archive",
                                "href": "https://github.com/onury/notation/releases",
                                "target": "_blank"
                            },
                            { "separator": true },
                            { "label": "Change-Log", "href": "changelog/" }
                        ]
                    },
                    {
                        "iconClass": "fa-lg fab fa-github",
                        "label": "GitHub",
                        "href": "https://github.com/onury/notation",
                        "target": "_blank"
                    }
                ]
            }
        }
    },
    "src": [
        "./src/core/**/*.js",
        "./CHANGELOG.md",
        {
            "guide": "./README.md"
        }
    ],
    "dest": "../onury.github.io/notation",
    "clean": true
}