diff options
| author | Paul Donald | 2026-02-22 15:51:25 +0000 |
|---|---|---|
| committer | Paul Donald | 2026-02-22 15:51:25 +0000 |
| commit | 7f6ba9d46028635f0d5aa2e15fcab9ffd163a688 (patch) | |
| tree | 9859ba29f58ce0a756f40d86e3ae924f9c77a7c9 | |
| parent | a7c82c559637d7748ed7045089eef55076c92d3b (diff) | |
| download | luci-7f6ba9d46028635f0d5aa2e15fcab9ffd163a688.tar.gz | |
docs: favicon and hierarchy
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>
| -rw-r--r-- | doc_gen/README.md | 2 | ||||
| l--------- | doc_gen/include/favicon.png | 1 | ||||
| -rw-r--r-- | docs/index.html | 6 | ||||
| -rw-r--r-- | jsdoc.conf.json | 11 |
4 files changed, 16 insertions, 4 deletions
diff --git a/doc_gen/README.md b/doc_gen/README.md index 4dd22db20a..d2c88e9239 100644 --- 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 index 0000000000..9bce86e99f --- /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 index 0000000000..92434f2b42 --- /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 ad7b2bd6d6..6b813bbb6d 100644 --- 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, |
