wanikani-api-types/typedoc.json at main · bachman-dev/wanikani-api-types · 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
{
  "$schema": "./node_modules/typedoc/typedoc-config.schema.json",
  "name": "WaniKani API Types",
  "entryPoints": ["packages/*"],
  "entryPointStrategy": "packages",
  "packageOptions": {
    "entryPoints": ["src/v20170710/index.ts", "src/index.ts"]
  },
  "readme": "./packages/types/README.md",
  "out": "docs",
  "plugin": ["./typedoc/plugin.js"],
  "router": "cloudflare",
  "externalSymbolLinkMappings": {
    "valibot": {
      "ValiError": "https://valibot.dev/api/ValiError/"
    }
  },
  "highlightLanguages": ["bash", "console", "diff", "javascript", "json", "jsonc", "typescript", "tsx"],
  "cleanOutputDir": true,
  "includeVersion": true,
  "navigation": {
    "includeCategories": true
  },
  "sort": ["alphabetical"],
  "visibilityFilters": { "private": false },
  "treatWarningsAsErrors": true,
  "requiredToBeDocumented": [
    "Enum",
    "EnumMember",
    "Variable",
    "Function",
    "Class",
    "Interface",
    "Property",
    "Method",
    "Accessor",
    "TypeAlias"
  ],
  "validation": {
    "notDocumented": true,
    "invalidLink": true,
    "notExported": true
  }
}