openwrt/luci
1
0
Fork 0
mirror of https://github.com/openwrt/luci.git synced 2026-04-15 10:51:51 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: favicon and hierarchy

Browse Source 
Moving the output to /luci breaks existing links out there
so let's do our best to output to /luci/jsapi

Include a favicon also as a static resource.

Signed-off-by: Paul Donald <newtwen+github@gmail.com>
This commit is contained in:
Paul Donald
2026-02-22 16:51:25 +01:00
parent a7c82c5596
commit 7f6ba9d460
4 changed files with 16 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
doc_gen/README.md
View File

@@ -7,4 +7,4 @@ Start with the [LuCI Client side JavaScript APIs](LuCI.html)
## Historical ## Historical
The older [Lua API docs](api/index.html) are available for historical reference. The older [Lua API docs](../api/index.html) are available for historical reference.

1
doc_gen/include/favicon.png Symbolic link
View File

@@ -0,0 +1 @@
../../themes/luci-theme-bootstrap/htdocs/luci-static/bootstrap/logo_48.png

6
docs/index.html Normal file
View File

@@ -0,0 +1,6 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="refresh" content="0; url=/luci/jsapi" />
</head>
</html>

11
jsdoc.conf.json
View File

@@ -14,14 +14,19 @@
"cleverLinks": true, "cleverLinks": true,
"monospaceLinks": true, "monospaceLinks": true,
"default": { "default": {
"outputSourceFiles": true "outputSourceFiles": true,
"staticFiles": {
"include": [
"doc_gen/include"
]
}
} }
}, },
"opts": { "opts": {
"template": "node_modules/clean-jsdoc-theme", "template": "node_modules/clean-jsdoc-theme",
"template_alt": "@alphanull/jsdoc-vision-theme", "template_alt": "@alphanull/jsdoc-vision-theme",
"template_old": "jaguarjs-jsdoc", "template_old": "jaguarjs-jsdoc",
"destination": "docs/", "destination": "docs/jsapi",
"destination_comment": "output directory in the repo", "destination_comment": "output directory in the repo",
"recurse": true, "recurse": true,
"readme": "doc_gen/README.md", "readme": "doc_gen/README.md",
@@ -30,7 +35,7 @@
"tutorials_comment": "tutorials index. See 'sections' below. jaguarjs does not like the tutorials entry", "tutorials_comment": "tutorials index. See 'sections' below. jaguarjs does not like the tutorials entry",
"theme_opts": { "theme_opts": {
"default_theme": "fallback-dark", "default_theme": "fallback-dark",
"favicon": "themes/luci-theme-bootstrap/htdocs/luci-static/bootstrap/logo.svg", "favicon": "favicon.png",
"title": "LuCI Documentation", "title": "LuCI Documentation",
"homepageTitle": "LuCI - Reference Documentation", "homepageTitle": "LuCI - Reference Documentation",
"displayModuleHeader": false, "displayModuleHeader": false,