mirror of
https://github.com/openwrt/luci.git
synced 2026-04-15 10:51:51 +00:00
7f6ba9d460
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>
67 lines
1.5 KiB
JSON
67 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,
|
|
"staticFiles": {
|
|
"include": [
|
|
"doc_gen/include"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"opts": {
|
|
"template": "node_modules/clean-jsdoc-theme",
|
|
"template_alt": "@alphanull/jsdoc-vision-theme",
|
|
"template_old": "jaguarjs-jsdoc",
|
|
"destination": "docs/jsapi",
|
|
"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": "favicon.png",
|
|
"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
|
|
}
|
|
}
|