forked from juliencrn/usehooks-ts
-
Notifications
You must be signed in to change notification settings - Fork 0
/
typedoc.json
68 lines (63 loc) · 1.62 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
{
"$schema": "https://typedoc.org/schema.json",
// Essentials
"name": "usehooks-ts",
"tsconfig": "packages/usehooks-ts/tsconfig.json",
"jsDocCompatibility": true,
"entryPoints": ["packages/usehooks-ts/src/**/*.ts"],
"entryPointStrategy": "resolve",
"json": "./generated/typedoc/all.json",
"out": "./generated/typedoc",
"readme": "none",
// Exclude
"exclude": [
"packages/usehooks-ts/src/**/demo.*",
"packages/usehooks-ts/src/**/test.*",
"packages/usehooks-ts/src/**/index.ts"
],
"externalPattern": ["**/node_modules/**"],
"excludeExternals": true,
"excludePrivate": true,
"excludeProtected": true,
"excludeInternal": true,
"excludeNotDocumented": true,
"excludeReferences": true,
"excludeTags": [
"@override",
"@virtual",
"@privateRemarks",
"@satisfies",
"@overload",
"@example",
"@see"
],
// Plugins
"plugin": [
"typedoc-plugin-mdn-links",
"typedoc-plugin-markdown",
"typedoc-plugin-missing-exports"
],
// Validation
"validation": {
"notExported": true,
"invalidLink": true,
"notDocumented": false
},
// Emit warnings for any tags not listed here
"blockTags": ["@param", "@returns", "@see", "@example", "@template"],
// Markdown and styles
"allReflectionsHaveOwnDocument": true,
"hidePageTitle": true,
"hideInPageTOC": true,
"hideGenerator": true,
"hideBreadcrumbs": true,
"hideParameterTypesInTitle": true,
"navigation": {
"includeCategories": false,
"includeGroups": false,
"includeFolders": false
},
"sort": ["alphabetical"],
"preserveLinkText": true,
"placeInternalsInOwningModule": true
}