From 9bc5f2e7f5c06def86dbd9dc1ed5f947941cc139 Mon Sep 17 00:00:00 2001 From: "Md. Abdul aziz" Date: Wed, 11 Oct 2023 08:58:10 +0200 Subject: [PATCH] Js docs menu blocks (#4280) * JSdoc menu blocks solved by install new template foodoc * Solve JSdocs menu blocks by installing new template and add custom css * Revert package-lock.json to a previos state --- build/jsdoc/jsdoc_conf.json | 14 +++++++++++--- build/style_jsdoc/jsdoc-custom.css | 18 ++++++++++++++++++ package.json | 2 ++ 3 files changed, 31 insertions(+), 3 deletions(-) create mode 100644 build/style_jsdoc/jsdoc-custom.css diff --git a/build/jsdoc/jsdoc_conf.json b/build/jsdoc/jsdoc_conf.json index 794b426281..2cd4c87b15 100644 --- a/build/jsdoc/jsdoc_conf.json +++ b/build/jsdoc/jsdoc_conf.json @@ -12,7 +12,8 @@ "plugins/markdown" ], "markdown": { - "hardwrap": true + "hardwrap": true, + "idInHeadings": true }, "templates": { "cleverLinks": true, @@ -21,6 +22,7 @@ "outputSourceFiles": true, "outputSourcePath": true, "systemName": "dash.js", + "systemSummary": "", "copyright": "

DASH Industry Forum

", "footer": "", "navType": "horizontal", @@ -31,11 +33,17 @@ "highlightTutorialCode": true }, "opts": { - "template": "../../node_modules/ink-docstrap/template", + "template": "../../node_modules/clean-jsdoc-theme", "encoding": "utf8", "recurse": true, "query": "value", "private": false, - "lenient": true + "lenient": true, + "verbose": true, + "destination": "docs/", + "theme_opts": { + "default_theme": "light", + "include_css": ["./build/style_jsdoc/jsdoc-custom.css"] + } } } diff --git a/build/style_jsdoc/jsdoc-custom.css b/build/style_jsdoc/jsdoc-custom.css new file mode 100644 index 0000000000..cb4f0803ae --- /dev/null +++ b/build/style_jsdoc/jsdoc-custom.css @@ -0,0 +1,18 @@ +td, th { + padding: 10px 10px !important; + word-wrap: break-word; + max-width: 50px; + white-space: inherit; + text-overflow: ellipsis; + } + + /* Optional: Style the first and last columns differently */ + td:nth-child(5), th:nth-child(5) { + max-width: 150px !important; + } + td:first-child, th:first-child { + max-width: 100px !important; + } +.main-wrapper { + padding: 0 !important; +} \ No newline at end of file diff --git a/package.json b/package.json index 5a6fd9c8f2..d100d0a26b 100644 --- a/package.json +++ b/package.json @@ -62,9 +62,11 @@ "dependencies": { "bcp-47-match": "^1.0.3", "bcp-47-normalize": "^1.1.1", + "clean-jsdoc-theme": "^4.2.10", "codem-isoboxer": "0.3.9", "es6-promise": "^4.2.8", "fast-deep-equal": "2.0.1", + "foodoc": "^0.0.9", "html-entities": "^1.2.1", "imsc": "^1.1.3", "localforage": "^1.7.1",