summaryrefslogtreecommitdiffhomepage
path: root/jsdoc
diff options
context:
space:
mode:
authorJo-Philipp Wich <jo@mein.io>2023-07-13 10:59:19 +0200
committerGitHub <noreply@github.com>2023-07-13 10:59:19 +0200
commit64e774b05d76753454cda01b853f2ab31d571623 (patch)
tree80057605fc621691130c2d4bdb3bdde4a1db034e /jsdoc
parentc3fe389ad87810235b1a8ac8080adf47776cc922 (diff)
parentf1190ef2f2719582efcad4109f1215b02baebfdf (diff)
Merge pull request #164 from jow-/docs-improvements
docs: various improvements
Diffstat (limited to 'jsdoc')
-rw-r--r--jsdoc/conf.json40
1 files changed, 33 insertions, 7 deletions
diff --git a/jsdoc/conf.json b/jsdoc/conf.json
index 50be361..de7b0e8 100644
--- a/jsdoc/conf.json
+++ b/jsdoc/conf.json
@@ -13,17 +13,43 @@
"jsdoc/c-transpiler"
],
- "templates": {
- "referenceTitle": "OpenWrt ucode library reference",
- "disableSort": false,
- "collapse": true,
- "resources_": {
- "OpenWrt": "https://openwrt.org/"
+ "templates2": {
+ "cleverLinks": true,
+ "monospaceLinks": true,
+ "default": {
+ "outputSourceFiles": true,
+ "useLongnameInNav": true
}
},
+ "markdown": {
+ "hardwrap": false,
+ "idInHeadings": true
+ },
"opts": {
+ "template": "node_modules/clean-jsdoc-theme",
"destination": "docs",
"recurse": true,
- "readme": "docs/README.md"
+ "readme": "docs/README.md",
+ "theme_opts": {
+ "default_theme": "light",
+ "title": "ucode Documentation",
+ "homepageTitle": "ucode - Reference Documentation",
+ "displayModuleHeader": true,
+ "prefixModuleToSidebarItems_experimental": true,
+ "includeFilesListInHomepage": true,
+ "include_css": [
+ "docs/ucode.css"
+ ],
+ "include_js": [
+ "docs/ucode.js"
+ ],
+ "menu": [
+ {
+ "title": "GitHub Project Page",
+ "link": "https://github.com/jow-/ucode",
+ "class": "github-home"
+ }
+ ]
+ }
}
}