ctrf-js/typedoc.json at main · ctrf-io/ctrf-js · 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
{
  "$schema": "https://typedoc.org/schema.json",
  "entryPoints": ["src/index.ts"],
  "entryPointStrategy": "expand",
  "out": "docs",
  "exclude": [
    "src/__tests__/**/*",
    "src/**/*.test.ts",
    "src/**/*.spec.ts",
    "src/cli/**/*"
  ],
  "excludePrivate": true,
  "excludeProtected": true,
  "excludeInternal": true,
  "excludeNotDocumented": false,
  "excludeExternals": true,
  "excludeReferences": false,
  "includeVersion": false,
  "categorizeByGroup": true,
  "sort": ["source-order", "required-first", "kind"],
  "kindSortOrder": ["Function", "Class", "Interface", "TypeAlias", "Variable"],
  "groupOrder": [
    "Core Operations",
    "Builders",
    "Core Types",
    "Query & Filter",
    "Insights",
    "Merge",
    "Schema & Versioning",
    "Type Guards",
    "ID Generation",
    "Core Options",
    "Builder Options",
    "Query & Filter Options",
    "Insights Options",
    "Merge Options",
    "Validation Options",
    "Errors",
    "Constants",
    "*"
  ],
  "readme": "API.md",
  "useFirstParagraphOfCommentAsSummary": true,
  "plugin": ["typedoc-plugin-markdown"],
  "name": "CTRF",
  "githubPages": false,
  "gitRemote": "origin",
  "gitRevision": "main",
  "cleanOutputDir": true,
  "validation": {
    "notExported": true,
    "invalidLink": true,
    "notDocumented": false
  }
}