docma.json

onury · Jun 9, 2018 · 2b3210b · 2b3210b
1 parent ac6e674
commit 2b3210b
Show file tree

Hide file tree

Showing 2 changed files with 145 additions and 114 deletions.
diff --git a/docma.config.json b/docma.config.json
diff --git a/docma.json b/docma.json
@@ -0,0 +1,145 @@
+{
+    "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": 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": "AccessControl",
+        "meta": null,
+        "base": "/accesscontrol",
+        "entrance": "content:guide",
+        "routing": "query",
+        "server": "github"
+    },
+    "template": {
+        "path": "zebra",
+        "options": {
+            "title": {
+                "label": "AccessControl",
+                "href": "/accesscontrol/?"
+            },
+            "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": [
+                    {
+                        "iconClass": "ico-mouse-pointer",
+                        "label": "Guide",
+                        "href": "./?content=guide"
+                    },
+                    {
+                        "iconClass": "ico-md ico-info",
+                        "label": "F.A.Q.",
+                        "href": "./?content=faq"
+                    },
+                    {
+                        "iconClass": "ico-book",
+                        "label": "API Reference",
+                        "href": "./?api=ac"
+                    },
+                    {
+                        "iconClass": "ico-md ico-download",
+                        "label": "Download",
+                        "items": [
+                            {
+                                "label": "<code>npm i accesscontrol --save</code>",
+                                "href": "https://www.npmjs.com/package/accesscontrol",
+                                "target": "_blank"
+                            },
+                            {
+                                "label": "<code>yarn add accesscontrol</code>",
+                                "href": "https://yarn.pm/accesscontrol",
+                                "target": "_blank"
+                            },
+                            {
+                                "separator": true
+                            },
+                            {
+                                "label": "Download as Archive",
+                                "href": "https://github.com/onury/accesscontrol/releases",
+                                "target": "_blank"
+                            },
+                            {
+                                "separator": true
+                            },
+                            {
+                                "label": "Change Log",
+                                "href": "?content=changelog"
+                            }
+                        ]
+                    },
+                    {
+                        "iconClass": "ico-md ico-github",
+                        "label": "GitHub",
+                        "href": "https://github.com/onury/accesscontrol",
+                        "target": "_blank"
+                    }
+                ]
+            }
+        }
+    },
+    "src": [
+        {
+            "ac": [
+                "./lib/**/*.js",
+                "!./lib/utils.js"
+            ]
+        },
+        "./CHANGELOG.md",
+        "./docs/FAQ.md",
+        {
+            "guide": "./README.md"
+        }
+    ],
+    "dest": "../onury.github.io/accesscontrol"
+}