desktop/typedoc.json at main · datalayer/desktop · 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
{
  "$schema": "https://typedoc.org/schema.json",
  "entryPoints": ["./src"],
  "entryPointStrategy": "expand",
  "out": "./docs",
  "exclude": [
    "**/*.test.ts",
    "**/*.spec.ts",
    "**/node_modules/**",
    "**/dist/**",
    "**/dist-electron/**",
    "**/polyfills/**",
    "**/lodash-polyfills.js",
    "**/jupyterlab-services-proxy.js"
  ],
  "tsconfig": "./tsconfig.json",
  "name": "Datalayer Desktop",
  "readme": "./README.md",
  "theme": "default",
  "includeVersion": true,
  "excludePrivate": false,
  "excludeProtected": false,
  "excludeInternal": true,
  "excludeExternals": false,
  "disableSources": false,
  "gitRevision": "main",
  "hideGenerator": false,
  "validation": {
    "notExported": false,
    "invalidLink": true,
    "notDocumented": false
  },
  "categorizeByGroup": true,
  "defaultCategory": "Other",
  "categoryOrder": [
    "Main Process",
    "Preload",
    "Renderer",
    "Components",
    "Hooks",
    "Services",
    "Stores",
    "Utilities",
    "Types",
    "*",
    "Other"
  ],
  "navigationLinks": {
    "GitHub": "https://github.com/datalayer/desktop",
    "Datalayer": "https://datalayer.io"
  },
  "excludeTags": ["@internal"],
  "commentStyle": "JSDoc",
  "blockTags": [
    "@module",
    "@description",
    "@param",
    "@returns",
    "@example",
    "@see",
    "@since",
    "@deprecated",
    "@throws",
    "@component",
    "@category"
  ],
  "inlineTags": ["@link", "@linkcode", "@linkplain"],
  "modifierTags": [
    "@public",
    "@private",
    "@protected",
    "@readonly",
    "@override",
    "@virtual",
    "@abstract",
    "@async",
    "@generator"
  ],
  "lightHighlightTheme": "github-light",
  "darkHighlightTheme": "github-dark"
}