typelab/typedoc.json at main · codeismyid/typelab · GitHub

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
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
{
  "$schema": "https://typedoc-plugin-markdown.org/schema.json",
  "plugin": ["typedoc-plugin-markdown"],

  // input
  "entryPoints": ["./lib/**/index.ts"],
  "exclude": ["**/__internal/*.ts", "./lib/index.ts"],
  "entryPointStrategy": "resolve",
  "useTsLinkResolution": true,
  "externalSymbolLinkMappings": {
    "typescript": {
      "*": "#"
    }
  },

  // output
  "out": "./docs",
  "router": "structure",
  "alwaysCreateEntryPointModule": false,
  "flattenOutputFiles": false,
  "useCodeBlocks": true,
  "expandObjects": true,
  "preserveAnchorCasing": true,
  "hidePageHeader": true,
  "hidePageTitle": true,
  "hideGroupHeadings": true,
  "hideBreadcrumbs": false,
  "readme": "none",

  // output > exclude
  "excludeInternal": true,
  "excludeNotDocumented": true,
  "excludeReferences": true,
  "intentionallyNotExported": [
    "_IsTrue",
    "_IsTrueAndNotNever",
    "_IfNotAnyOrNever",
    "_IfNotAny",
    "_IfNotAnyOrNeverOrUnknown",
    "_IfUnion",
    "_ArrayFlat",
    "_ArrayTakeNegative",
    "_ArrayTakePositive",
    "_ArraySkipNegative",
    "_ArraySkipPositive",
    "_ArrayRequired",
    "_ArrayPartial",
    "_ArrayRequiredIndexes",
    "_ArrayOptionalIndexes",
    "_ArrayRequiredElements",
    "_ArrayOptionalElements",
    "_ArrayOmitRequired",
    "_ArrayOmitOptional",
    "_ArrayToObject",
    "_ArrayAssign",
    "_ArrayOverwrite",
    "_ArrayMerge",
    "_ArrayUnionize",
    "_Decrement",
    "_Increment",
    "_ObjectRequired",
    "_ObjectPartial",
    "_Lookup",
    "_ObjectToTuple",
    "_ObjectAssignPreCheck",
    "_ObjectAssignPrimitive",
    "_ObjectAssignArray",
    "_ObjectAssignObject",
    "_ObjectOverwrite",
    "_UnionToTuple",
    "_LookupType",
    "_ObjectUnionizeDeep"
  ],

  // output > doc format
  "indexFormat": "htmlTable",
  "enumMembersFormat": "htmlTable",
  "parametersFormat": "htmlTable",
  "interfacePropertiesFormat": "htmlTable",
  "classPropertiesFormat": "htmlTable",
  "propertyMembersFormat": "htmlTable",
  "typeDeclarationFormat": "htmlTable",

  // output > table format
  "tableColumnSettings": {
    "hideDefaults": false,
    "hideInherited": false,
    "hideModifiers": false,
    "hideOverrides": false,
    "hideSources": false,
    "hideValues": false,
    "leftAlignHeaders": false
  },

  // output > sorter
  "sort": ["kind", "source-order"],

  // validation
  "validation": {
    "notDocumented": true,
    "notExported": true,
    "invalidPath": true,
    "rewrittenLink": true,
    "invalidLink": true,
    "unusedMergeModuleWith": true
  },
  "treatValidationWarningsAsErrors": true,

  // resolution
  "disableGit": true,
  "disableSources": true
}