-
Notifications
You must be signed in to change notification settings - Fork 18
/
jsdoc.conf.json
67 lines (67 loc) · 1.77 KB
/
jsdoc.conf.json
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
67
{
"tags": {
"allowUnknownTags": true,
"dictionaries": ["jsdoc"]
},
"source": {
"include": ["src"],
"includePattern": ".(js|ts)$",
"excludePattern": "(node_modules/|docs)"
},
"sourceType": "module",
"plugins": ["plugins/markdown", "node_modules/better-docs/typescript"],
"templates": {
"cleverLinks": false,
"monospaceLinks": true,
"useLongnameInNav": true,
"showInheritedInNav": true,
"default": {
"includeDate": false,
"staticFiles": {
"include": ["./docs/static"]
}
}
},
"opts": {
"template": "node_modules/clean-jsdoc-theme",
"encoding": "utf8",
"destination": "./docs/api",
"recurse": true,
"hierarchy": true,
"readme": "README.md",
"tutorials": "./docs/tutorials",
"theme_opts": {
"default_theme": "dark",
"base_url": "https://bbc.github.io/bigscreen-player/api/",
"favicon": "favicon.ico",
"homepageTitle": "Docs: Bigscreen Player",
"title": "<a href='index.html'><img alt='The logo for bigscreen player' src='bsp-logo.png'/></a>",
"menu": [
{ "title": "Home", "link": "index.html" },
{ "title": "Repo", "link": "https://github.com/bbc/bigscreen-player" }
],
"sections": ["Tutorials", "Modules"],
"displayModuleHeader": true,
"meta": [
{
"name": "description",
"content": "Simplified media playback for bigscreen devices"
}
],
"search": {
"shouldSort": true,
"threshold": 0.4,
"location": 0,
"distance": 100,
"maxPatternLength": 32,
"minMatchCharLength": 1
},
"footer": ""
}
},
"markdown": {
"$comment": "Important for `clean-jsdoc-theme`",
"hardwrap": false,
"idInHeadings": true
}
}