docma-config.json

{
    "debug": 1,
    "jsdoc": {
        "encoding": "utf8",
        "recurse": false,
        "pedantic": false,
        "access": null,
        "package": null,
        "module": true,
        "undocumented": false,
        "undescribed": false,
        "hierarchy": true,
        "sort": "alphabetic",
        "relativePath": null,
        "filter": null,
        "allowUnknownTags": true,
        "plugins": ["plugins/markdown"]
    },
    "markdown": {
        "gfm": true,
        "tables": true,
        "breaks": false,
        "pedantic": false,
        "sanitize": false,
        "smartLists": true,
        "smartypants": false,
        "tasks": true,
        "emoji": true
    },
    "app": {
        "title": "MapStore 2 documentation",
        "base": "/mapstore/docs",
        "entrance": "content:site",
        "routing": { "method": "path", "caseSensitive": true }
    },
    "template": {
        "path": "default",
        "options": {
            "title": "MapStore 2",
            "sidebar": true,
            "collapsed": false,
            "outline": "tree",
            "badges": true,
            "search": true,
            "navbar": true,
            "navItems": [
                {
                    "iconClass": "ico-book",
                    "label": "Guides",
                    "items": [
                        { "label": "Home", "href": "./" },
                        { "separator": true },
                        { "label": "Developer's guide", "href": "developer-guide" },
                        { "separator": true },
                        { "label": "Plugins Architecture", "href": "plugins-architecture" },
                        { "label": "Configuring Plugins", "href": "plugins-documentation" },
                        { "separator": true },
                        { "label": "Project Creation Script", "href": "project-creation-script" }
                    ]
                },
                {
                    "iconClass": "ico-mouse-pointer",
                    "label": "Reference",
                    "items": [
                        { "label": "Framework", "href": "api/framework"},
                        { "separator": true },
                        { "label": "JavaScript API", "href": "api/jsapi" },
                        { "separator": true },
                        { "label": "Plugins", "href": "api/plugins" }
                    ]
                },
                {
                    "iconClass": "ico-md ico-download",
                    "label": "Download",
                    "href": "index.html",
                    "items": [
                        {
                            "label": "MapStore 2 Releases",
                            "href": "https://github.com/geosolutions-it/MapStore2/releases",
                            "target": "_blank"
                        },
                        {
                            "label": "MapStore 2 tar.gz",
                            "href": "https://github.com/geosolutions-it/MapStore2/tarball/master",
                            "target": "_blank"
                        },
                        {
                            "label": "MapStore 2 .zip",
                            "href": "https://github.com/geosolutions-it/MapStore2/zipball/master",
                            "target": "_blank"
                        }

                    ]
                },
                {
                    "iconClass": "ico-md ico-github",
                    "label": "GitHub",
                    "href": "https://github.com/geosolutions-it/MapStore2",
                    "target": "_blank"
                }
            ]
        }
    },
    "src": [
        {
          "framework": [
            "web/client/components/index.jsdoc",
            "web/client/components/buttons/FullScreenButton.jsx",
            "web/client/components/buttons/GlobeViewSwitcherButton.jsx",
            "web/client/components/buttons/GoFullButton.jsx",
            "web/client/components/mapcontrols/search/SearchBar.jsx",
            "web/client/components/buttons/ToggleButton.jsx",
            "web/client/components/plugins/PluginsContainer.jsx",

            "web/client/actions/index.jsdoc",
            "web/client/actions/controls.js",
            "web/client/actions/fullscreen.js",
            "web/client/actions/globeswitcher.js",
            "web/client/actions/maps.js",
            "web/client/actions/maptype.js",
            "web/client/actions/search.js",

            "web/client/selectors/index.jsdoc",
            "web/client/selectors/map.js",
            "web/client/selectors/maptype.js",
            "web/client/selectors/tutorial.js",

            "web/client/reducers/index.jsdoc",
            "web/client/reducers/controls.js",
            "web/client/reducers/globeswitcher.js",
            "web/client/reducers/maps.js",
            "web/client/reducers/maptype.js",
            "web/client/reducers/search.js",

            "web/client/epics/index.jsdoc",
            "web/client/epics/fullscreen.js",
            "web/client/epics/globeswitcher.js",
            "web/client/epics/maptype.js",
            "web/client/epics/search.js",
            "web/client/epics/tutorial.js",
            "web/client/epics/wfsquery.js",

            "web/client/utils/index.jsdoc",
            "web/client/utils/CoordinatesUtils.js",
            "web/client/utils/PluginsUtils.js",
            "web/client/utils/PrintUtils.js",
            "web/client/utils/ShareUtils.js"
          ],
          "jsapi": "web/client/jsapi/MapStore2.js",
            "plugins": [
                "web/client/plugins/index.jsdoc",
                "web/client/plugins/BackgroundSelector.jsx",
                "web/client/plugins/BackgroundSwitcher.jsx",
                "web/client/plugins/DrawerMenu.jsx",
                "web/client/plugins/GlobeViewSwitcher.jsx",
                "web/client/plugins/GoFull.jsx",
                "web/client/plugins/Map.jsx",
                "web/client/plugins/Measure.jsx",
                "web/client/plugins/MeasurePanel.jsx",
                "web/client/plugins/MeasureResults.jsx",
                "web/client/plugins/FullScreen.jsx",
                "web/client/plugins/Identify.jsx",
                "web/client/plugins/Locate.jsx",
                "web/client/plugins/Login.jsx",
                "web/client/plugins/ScaleBox.jsx",
                "web/client/plugins/ScrollTop.jsx",
                "web/client/plugins/Search.jsx",
                "web/client/plugins/SearchServicesConfig.jsx",
                "web/client/plugins/ZoomIn.jsx",
                "web/client/plugins/ZoomOut.jsx"
            ]
        },
        "./docs/**/*md",
        {
            "readme": "./README.md",
            "developer-guide": "./docs/developer-guide/index.md",
            "site": "./docs/index.md"
        }
    ]
}