docma.json

{
    "debug": 3,
    "jsdoc": {
        "encoding": "utf8",
        "recurse": false,
        "pedantic": false,
        "access": null,
        "package": null,
        "module": true,
        "undocumented": false,
        "undescribed": false,
        "ignored": false,
        "hierarchy": true,
        "sort": "alphabetic",
        "relativePath": null,
        "filter": null,
        "allowUnknownTags": true,
        "plugins": []
    },
    "markdown": {
        "gfm": true,
        "tables": true,
        "breaks": false,
        "pedantic": false,
        "sanitize": false,
        "smartLists": true,
        "smartypants": false,
        "xhtml": false,
        "tasks": true,
        "emoji": true
    },
    "app": {
        "title": "Docma Documentation",
        "meta": null,
        "base": ".",
        "entrance": "content:home",
        "routing": "path",
        "server": "github",
        "favicon": "./favicon.ico" // local path of favicon to be copied
    },
    "template": {
        "path": "./templates/zebra", // set to "zebra" (this path is for this repo only)
        "options": {
            "title": {
                "label": "Docma",
                "href": "."
            },
            "logo": {
                // URL String or { dark: String, light: String }
                "dark": "img/docma-logo.png",
                "light": "img/docma-logo.png"
            },
            "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",
                "faLibs": "all" // "all" or "solid"|"regular"|"brands" or comma-separated or null
            },
            "navbar": {
                "enabled": true,
                "fixed": true,
                "dark": false,
                "animations": true,
                "menu": [
                    {
                        "iconClass": "fas fa-book",
                        "label": "Building Docs",
                        "items": [
                            {
                                "label": "Guide",
                                "href": "."
                            },
                            {
                                "separator": true
                            },
                            {
                                "label": "Docma (Builder) API",
                                "href": "api"
                            },
                            {
                                "label": "Build Configuration",
                                "href": "api/#Docma~BuildConfiguration"
                            }
                        ]
                    },
                    {
                        "iconClass": "fas fa-puzzle-piece",
                        "label": "Templates",
                        "items": [
                            {
                                "label": "Default Template - Zebra",
                                "href": "templates/zebra"
                            },
                            {
                                "separator": true
                            },
                            {
                                "label": "Docma Template API",
                                "href": "api/#Docma.Template"
                            },
                            {
                                "label": "Docma Web API",
                                "href": "api/web"
                            }
                        ]
                    },
                    {
                        "iconClass": "fas fa-cloud-download-alt",
                        "label": "Download",
                        "items": [
                            {
                                "label": "<code>npm i @pietal.dev/docma -D</code>",
                                "href": "https://www.npmjs.com/package/@pietal.dev/docma",
                                "target": "_blank"
                            },
                            {
                                "label": "Docma Releases",
                                "href": "https://github.com/Prozi/docma/releases",
                                "target": "_blank"
                            },
                            {
                                "separator": true
                            },
                            {
                                "label": "Change Log",
                                "href": "changelog"
                            }
                        ]
                    },
                    {
                        "iconClass": "fab fa-lg fa-github",
                        "label": "",
                        "href": "https://github.com/Prozi/docma",
                        "target": "_blank"
                    }
                ]
            }
        }
    },
    "src": [
        // API sources
        // default group (docma)
        // route @ api/
        "./src/Docma.js",
        "./src/Template.js",
        "./src/TemplateDoctor.js",
        // grouped JS API documentation
        {
            // route @ api/web/
            "web": ["./src/web/DocmaWeb.js", "./src/web/DocmaWeb.Route.js"],
            // route @ api/web/utils/
            "web/utils": "./src/web/DocmaWeb.Utils.js"
        },
        // Content sources
        // markdown
        "./CHANGELOG.md",
        "./README.md",
        "./LICENSE",
        {
            "home": "./README.md",
            // renamed markdown (deep routes)
            // "templates/guide": "./templates/guide.md",
            // "templates/filters": "./templates/filters.md",
            "templates/zebra": "./templates/zebra/README.md"
            // renamed html file
        }
    ],
    "assets": {
        "/img": ["./img/*.*"]
    },
    "dest": "./docs",
    "clean": true
}