mirror of
https://github.com/openwrt/luci.git
synced 2026-04-15 10:51:51 +00:00
44fd0155ff
- style with clean-jsdoc-theme (supports dark mode) - add tutorials (jaguar has a problem with this structure) - move doc gen stubs to doc_gen folder This change moves the generated JS API docs from /luci/jsapi to /luci via README.md which forms the index, and shall point to a generated html file which exists. It currently points to LuCI.html, which depends on JSDoc naming conventions. So it's possible the link can break if modules change names. But the TOC is always valid. Signed-off-by: Paul Donald <newtwen+github@gmail.com>
62 lines
1.5 KiB
JSON
62 lines
1.5 KiB
JSON
{
|
|
"tags": {
|
|
"allowUnknownTags": true,
|
|
"dictionaries": ["jsdoc","closure"]
|
|
},
|
|
"source": {
|
|
"include": ["modules/luci-base/htdocs/luci-static/resources"],
|
|
"includePattern": ".+\\.js(doc|x)?$"
|
|
},
|
|
"plugins": [
|
|
"plugins/markdown"
|
|
],
|
|
"templates": {
|
|
"cleverLinks": true,
|
|
"monospaceLinks": true,
|
|
"default": {
|
|
"outputSourceFiles": true
|
|
}
|
|
},
|
|
"opts": {
|
|
"template": "node_modules/clean-jsdoc-theme",
|
|
"template_alt": "@alphanull/jsdoc-vision-theme",
|
|
"template_old": "jaguarjs-jsdoc",
|
|
"destination": "docs/",
|
|
"destination_comment": "output directory in the repo",
|
|
"recurse": true,
|
|
"readme": "doc_gen/README.md",
|
|
"readme_comment": "generates the index.html file",
|
|
"tutorials": "doc_gen/tutorials",
|
|
"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",
|
|
"title": "LuCI Documentation",
|
|
"homepageTitle": "LuCI - Reference Documentation",
|
|
"displayModuleHeader": false,
|
|
"prefixModuleToSidebarItems_experimental": false,
|
|
"includeFilesListInHomepage": false,
|
|
"include_css": [
|
|
"doc_gen/extra.css"
|
|
],
|
|
"menu": [
|
|
{
|
|
"title": "GitHub Project Page",
|
|
"link": "https://github.com/openwrt/luci",
|
|
"class": "github-home"
|
|
}
|
|
],
|
|
"sections": [
|
|
"Tutorials",
|
|
"Modules",
|
|
"Classes",
|
|
"Externals"
|
|
]
|
|
}
|
|
},
|
|
"markdown": {
|
|
"hardwrap": false,
|
|
"idInHeadings": true
|
|
}
|
|
}
|