JSDoc: Style like openHAB docs, Display type defs, Reconfigure sections

build/jsdoc-openhab.css

@@ -0,0 +1,69 @@
+html {
+    --theme-color: #f60;
+    --theme-color-bg: #e65c00;
+}
+
+nav {
+    background-color: #f7f7f7;
+    border-right: 1px solid #eaecef;
+    width: 20rem;
+    left: 0;
+    padding-left: 1.25rem;
+    overflow-x: hidden;
+    white-space: nowrap;
+    text-overflow: ellipsis;
+}
+
+#main {
+    width: calc(100% - 20rem);
+}
+
+@media (max-width: 1023px) {
+    nav {
+        width: 16.4rem
+    }
+    #main {
+        width: calc(100% - 16.4rem);
+    }
+}
+
+a, a:active {
+    color: var(--theme-color);
+    font-weight: 500;
+}
+
+nav > h2 > a {
+    color: var(--theme-color) !important;
+    font-weight: 700;
+}
+
+nav > ul > li > a {
+    color: var(--theme-color);
+    font-weight: 600;
+}
+
+nav a:hover, nav a:active {
+    color: var(--theme-color);
+}
+
+/* container overview, e.g. namespace, method, type definition */
+h4.name {
+    background-color: var(--theme-color-bg);
+}
+
+.type-signature {
+    color: #803300;
+}
+
+.type-signature:last-child {
+    color: #f2f2f2;
+}
+
+.signature, .signature-attributes {
+    color: #4d1f00;
+}
+
+/* parameter list */
+span.param-type, .params td .param-type, .param-type dd {
+    color: #b34700;
+}

build/jsdoc.conf.json

@@ -1,51 +1,67 @@
 {
-    "tags": {
-        "allowUnknownTags": true,
-        "dictionaries": [
-            "jsdoc"
-        ]
-    },
-    "source": {
+  "tags": {
+    "allowUnknownTags": false,
+    "dictionaries": [
+      "jsdoc"
+    ]
+  },
+  "source": {
+    "include": [
+      "src",
+      "package.json",
+      "README.md"
+    ],
+    "includePattern": ".js$",
+    "excludePattern": "(node_modules/|docs|dist)"
+  },
+  "plugins": [
+    "plugins/markdown",
+    "node_modules/jsdoc-tsimport-plugin/index.js"
+  ],
+  "templates": {
+    "cleverLinks": false,
+    "monospaceLinks": true,
+    "useLongnameInNav": false,
+    "default": {
+      "staticFiles": {
         "include": [
-            "src",
-            "package.json",
-            "README.md"
-        ],
-        "includePattern": ".js$",
-        "excludePattern": "(node_modules/|docs|dist)"
-    },
-    "plugins": [
-        "plugins/markdown",
-        "node_modules/jsdoc-tsimport-plugin/index.js"
+          "./build/jsdoc-openhab.css"
+        ]
+      }
+    }
+  },
+  "opts": {
+    "destination": "./docs/",
+    "encoding": "utf8",
+    "private": false,
+    "recurse": true,
+    "template": "./node_modules/docdash"
+  },
+  "docdash": {
+    "static": true,
+    "sort": true,
+    "sectionOrder": [
+      "Namespaces",
+      "Global"
     ],
-    "templates": {
-        "cleverLinks": false,
-        "monospaceLinks": true,
-        "useLongnameInNav": false
+    "meta": {
+      "title": "openHAB JS",
+      "description": "JSDoc for openHAB JS - the openHAB JavaScript Helper Library"
     },
-    "opts": {
-        "destination": "./docs/",
-        "encoding": "utf8",
-        "private": false,
-        "recurse": true,
-        "template": "./node_modules/docdash"
+    "search": true,
+    "typedefs": true,
+    "scripts": [
+      "jsdoc-openhab.css"
+    ],
+    "menu": {
+      "Add-on Documentation": {
+        "href": "https://www.openhab.org/addons/automation/jsscripting/",
+        "target": "_blank",
+        "id": "addon_docs_link"
+      }
     },
-    "docdash": {
-        "sort": true,
-        "static": true,
-        "sectionOrder": [
-            "Namespaces",
-            "Classes",
-            "Modules",
-            "Externals",
-            "Events",
-            "Mixins",
-            "Tutorials",
-            "Interfaces"
-        ],
-        "search": true,
-        "scopeInOutputPath": false,
-        "nameInOutputPath": false,
-        "versionInOutputPath": false
-    }
+    "scopeInOutputPath": false,
+    "nameInOutputPath": false,
+    "versionInOutputPath": false
+  }
 }