summaryrefslogtreecommitdiffstats
path: root/jsdoc.conf.json
blob: 6b813bbb6dc48dc45e49c6e2ef07e2c0b973b0f1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
{
	"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
	}
}