auth0-ui-components/typedoc.json at main · auth0/auth0-ui-components · 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
{
  "$schema": "https://typedoc.org/schema.json",
  "name": "Auth0 Universal Components",
  "entryPoints": ["./packages/core/src/index.ts", "./packages/react/src/public-api.ts"],
  "entryPointStrategy": "expand",
  "out": "./docs-api",
  "readme": "./README.md",
  "treatWarningsAsErrors": true,
  "excludeInternal": true,
  "excludePrivate": true,
  "excludeProtected": true,
  "hideGenerator": true,
  "cleanOutputDir": true,
  "navigationLinks": {
    "GitHub": "https://github.com/auth0/auth0-ui-components",
    "Auth0": "https://auth0.com"
  },
  "categorizeByGroup": true,
  "categoryOrder": ["Providers", "Components", "Hooks", "Types", "Utilities", "*"],
  "validation": {
    "notExported": true,
    "invalidLink": true,
    "notDocumented": true
  },
  "exclude": [
    "**/node_modules/**",
    "**/examples/**",
    "**/__tests__/**",
    "**/__mocks__/**",
    "**/internals/**",
    "**/*.test.ts",
    "**/*.test.tsx",
    "**/*.spec.ts",
    "**/*.spec.tsx"
  ],
  "externalPattern": ["**/node_modules/**"],
  "skipErrorChecking": true,
  "tsconfig": "./tsconfig.json"
}