hyperscape/typedoc.json at main · terminaldestiny/hyperscape · 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
{
  "$schema": "https://typedoc.org/schema.json",
  "name": "Hyperscape API Documentation",
  "entryPointStrategy": "packages",
  "entryPoints": [
    "packages/shared",
    "packages/client",
    "packages/server"
  ],
  "out": "packages/docs-site/docs/api",
  "plugin": ["typedoc-plugin-markdown"],
  "outputFileStrategy": "modules",
  "fileExtension": ".md",
  "entryFileName": "index.md",
  "flattenOutputFiles": false,
  "membersWithOwnFile": ["Class", "Interface", "Enum"],
  "excludePrivate": true,
  "excludeProtected": false,
  "excludeInternal": true,
  "skipErrorChecking": true,
  "readme": "none",
  "exclude": [
    "**/node_modules/**",
    "**/dist/**",
    "**/build/**",
    "**/docs-site/**",
    "**/docs/**",
    "**/*.test.ts",
    "**/*.spec.ts",
    "**/test-*.ts",
    "**/test-*.tsx",
    "**/test-*.mjs",
    "**/scripts/**",
    "**/cypress/**",
    "**/__tests__/**",
    "**/*.test.tsx",
    "**/*.spec.tsx",
    "**/temp/**",
    "**/tmp/**",
    "**/libs/**",
    "**/vendor/**"
  ],
  "excludeExternals": true,
  "excludeReferences": false,
  "excludeNotDocumented": false,
  "includeVersion": true,
  "sort": ["source-order"],
  "disableSources": true,
  "commentStyle": "jsdoc",
  "categorizeByGroup": false,
  "validation": {
    "notExported": false,
    "invalidLink": false,
    "notDocumented": false
  },
  "treatWarningsAsErrors": false,
  "treatValidationWarningsAsErrors": false,
  "suppressCommentWarningsInDeclarationFiles": true,
  "logLevel": "Error",
  "tsconfig": "tsconfig.json",
  "githubPages": false,
  "hideGenerator": false,
  "navigationLinks": {
    "GitHub": "https://github.com/HyperscapeAI/hyperscape",
    "Documentation": "https://docs.hyperscape.xyz"
  }
}