summaryrefslogtreecommitdiffhomepage
path: root/jsdoc/conf.json
blob: e1487eb3599d1589d9827df48aee82840cbfd602 (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
{
	"tags": {
		"allowUnknownTags": true,
		"dictionaries": ["jsdoc","closure"]
	},
	"source": {
		"include": ["."],
		"exclude": ["CMakeFiles"],
		"includePattern": ".+\\.c$"
	},
	"plugins": [
		"plugins/markdown",
		"jsdoc/c-transpiler"

	],
	"templates2": {
		"cleverLinks": true,
		"monospaceLinks": true,
		"default": {
			"outputSourceFiles": true,
			"useLongnameInNav": true
		}
	},
	"markdown": {
		"hardwrap": false,
		"idInHeadings": true
	},
	"opts": {
		"template": "node_modules/clean-jsdoc-theme",
		"destination": "docs",
		"recurse": true,
		"readme": "docs/README.md",
		"tutorials": "docs/tutorials",
		"theme_opts": {
			"default_theme": "light",
			"title": "ucode Documentation",
			"homepageTitle": "ucode - Reference Documentation",
			"displayModuleHeader": true,
			"prefixModuleToSidebarItems_experimental": true,
			"includeFilesListInHomepage": true,
			"include_css": [
				"docs/ucode.css"
			],
			"include_js": [
				"docs/ucode.js"
			],
			"menu": [
				{
					"title": "GitHub Project Page",
					"link": "https://github.com/jow-/ucode",
					"class": "github-home"
				}
			],
			"sections": [
				"Tutorials",
				"Modules"
			]
		}
	}
}