git.99rst.org / openwrt-luci.git / commitdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side (parent: a7c82c5)
docs: favicon and hierarchy
authorPaul Donald <redacted>
Sun, 22 Feb 2026 15:51:25 +0000 (16:51 +0100)
committerPaul Donald <redacted>
Sun, 22 Feb 2026 15:51:25 +0000 (16:51 +0100)
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 <redacted>
doc_gen/README.md patch | blob | history
doc_gen/include/favicon.png [new symlink] patch | blob
docs/index.html [new file with mode: 0644] patch | blob
jsdoc.conf.json patch | blob | history

diff --git a/doc_gen/README.md b/doc_gen/README.md
index 4dd22db20a9ba1a11b94e7b528b12bf3d3c03cfd..d2c88e9239685a46d469cfcf2b04471747628836 100644 (file)
--- a/doc_gen/README.md
+++ b/doc_gen/README.md
@@ -7,4 +7,4 @@ Start with the [LuCI Client side JavaScript APIs](LuCI.html)
 
 ## Historical
 
-The older [Lua API docs](api/index.html) are available for historical reference.
\ No newline at end of file
+The older [Lua API docs](../api/index.html) are available for historical reference.
\ No newline at end of file
diff --git a/doc_gen/include/favicon.png b/doc_gen/include/favicon.png
new file mode 120000 (symlink)
index 0000000..9bce86e
--- /dev/null
+++ b/doc_gen/include/favicon.png
@@ -0,0 +1 @@
+../../themes/luci-theme-bootstrap/htdocs/luci-static/bootstrap/logo_48.png
\ No newline at end of file
diff --git a/docs/index.html b/docs/index.html
new file mode 100644 (file)
index 0000000..92434f2
--- /dev/null
+++ b/docs/index.html
@@ -0,0 +1,6 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta http-equiv="refresh" content="0; url=/luci/jsapi" />
+  </head>
+</html>
\ No newline at end of file
diff --git a/jsdoc.conf.json b/jsdoc.conf.json
index ad7b2bd6d6a84d2dd59c0e7652d760af57c8d6b7..6b813bbb6dc48dc45e49c6e2ef07e2c0b973b0f1 100644 (file)
--- a/jsdoc.conf.json
+++ b/jsdoc.conf.json
@@ -14,14 +14,19 @@
                "cleverLinks": true,
                "monospaceLinks": true,
                "default": {
-                       "outputSourceFiles": true
+                       "outputSourceFiles": true,
+                       "staticFiles": {
+                               "include": [
+                                       "doc_gen/include"
+                               ]
+                       }
                }
        },
        "opts": {
                "template": "node_modules/clean-jsdoc-theme",
                "template_alt": "@alphanull/jsdoc-vision-theme",
                "template_old": "jaguarjs-jsdoc",
-               "destination": "docs/",
+               "destination": "docs/jsapi",
                "destination_comment": "output directory in the repo",
                "recurse": true,
                "readme": "doc_gen/README.md",
@@ -30,7 +35,7 @@
                "tutorials_comment": "tutorials index. See 'sections' below. jaguarjs does not like the tutorials entry",
                "theme_opts": {
                        "default_theme": "fallback-dark",
-                       "favicon": "themes/luci-theme-bootstrap/htdocs/luci-static/bootstrap/logo.svg",
+                       "favicon": "favicon.png",
                        "title": "LuCI Documentation",
                        "homepageTitle": "LuCI - Reference Documentation",
                        "displayModuleHeader": false,
git clone https://git.99rst.org/PROJECT