Skip to content

Commit

Permalink
Js docs menu blocks (#4280)
Browse files Browse the repository at this point in the history
* 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
  • Loading branch information
abdulaziz-bd committed Oct 11, 2023
1 parent edf89c4 commit 9bc5f2e
Show file tree
Hide file tree
Showing 3 changed files with 31 additions and 3 deletions.
14 changes: 11 additions & 3 deletions build/jsdoc/jsdoc_conf.json
Expand Up @@ -12,7 +12,8 @@
"plugins/markdown"
],
"markdown": {
"hardwrap": true
"hardwrap": true,
"idInHeadings": true
},
"templates": {
"cleverLinks": true,
Expand All @@ -21,6 +22,7 @@
"outputSourceFiles": true,
"outputSourcePath": true,
"systemName": "dash.js",
"systemSummary": "",
"copyright": "<h3>DASH Industry Forum</h3>",
"footer": "",
"navType": "horizontal",
Expand All @@ -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"]
}
}
}
18 changes: 18 additions & 0 deletions 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;
}
2 changes: 2 additions & 0 deletions package.json
Expand Up @@ -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",
Expand Down

0 comments on commit 9bc5f2e

Please sign in to comment.