generated from JoshuaKGoldberg/create-typescript-app
-
-
Notifications
You must be signed in to change notification settings - Fork 7
/
typedoc.json
82 lines (82 loc) · 1.51 KB
/
typedoc.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
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
{
"$schema": "https://typedoc.org/schema.json",
"categoryOrder": [
"Node Types",
"Nodes - Type Guards",
"Nodes - Flag Utilities",
"Nodes - Other Utilities",
"Modifier Utilities",
"Scope Utilities",
"Syntax Utilities",
"Compiler Options",
"*",
"Other"
],
"customCss": "./docs/typedoc.css",
"customValidation": {
"byKind": [
{
"kinds": "Function",
"tags": ["example"],
"type": "code-only"
}
]
},
"defaultCategory": "Other",
"entryPoints": ["./src/index.ts"],
"exclude": ["./**/test/", "./**/*.test.*"],
"excludeExternals": true,
"excludeInternal": true,
"excludeNotDocumented": false,
"excludePrivate": true,
"excludeProtected": true,
"hideGenerator": true,
"includeVersion": true,
"kindSortOrder": [
"Reference",
"Project",
"Module",
"Namespace",
"Constructor",
"Property",
"Variable",
"Function",
"Accessor",
"Method",
"Parameter",
"Enum",
"EnumMember",
"Class",
"Interface",
"TypeAlias",
"TypeParameter",
"TypeLiteral",
"CallSignature",
"ConstructorSignature",
"IndexSignature",
"GetSignature",
"SetSignature"
],
"out": "./docs/generated",
"plugin": [
"typedoc-plugin-coverage",
"typedoc-plugin-custom-validation",
"typedoc-plugin-konamimojisplosion",
"typedoc-plugin-mdn-links",
"typedoc-plugin-versions"
],
"readme": "./docs/index.md",
"requiredToBeDocumented": [
"Accessor",
"CallSignature",
"Class",
"Enum",
"Function",
"Interface",
"Method",
"TypeAlias"
],
"versions": {
"makeRelativeLinks": true
}
}