generated from RebeccaStevens/template-typescript-node-package
-
-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathtypedoc.json
77 lines (77 loc) · 1.67 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
{
"$schema": "https://typedoc.org/schema.json",
"categoryOrder": ["Base", "Derived", "*", "Other"],
"defaultCategory": "Other",
"groupOrder": [
"Units",
"Modifiers",
"Abstract Units",
"Unit Components",
"Unit Classes",
"Unit Class Modifiers",
"Unit Generators",
"Abstract Unit Generators",
"Unit Functions",
"Unit Subvalue Functions",
"Exponent Functions",
"Unknown Units",
"*"
],
"navigation": {
"includeCategories": true,
"includeGroups": true
},
"entryPoints": ["src/index.ts"],
"exclude": ["./*.ts", "./dist/", "./scripts/", "./tests/"],
"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"
],
"tsconfig": "src/tsconfig.json",
"out": "./docs/generated",
"plugin": ["typedoc-plugin-coverage"],
"readme": "./docs/index.md",
"customCss": "./docs/typedoc.css",
"requiredToBeDocumented": [
"Accessor",
"CallSignature",
"Class",
"Enum",
"Function",
"Interface",
"Method",
"TypeAlias"
],
"inlineTags": ["@link", "@inheritDoc", "@label", "@linkcode", "@linkplain", "@symbol"],
"compilerOptions": {
"noCheck": true
}
}