crawlee-scraper-toolkit/typedoc.json at main · devalexanderdaza/crawlee-scraper-toolkit · 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
{
  "entryPoints": ["src/index.ts"],
  "out": "docs/api",
  "plugin": [
    "typedoc-plugin-markdown",
    "typedoc-plugin-missing-exports"
  ],
  "theme": "markdown",
  "readme": "README.md",
  "excludePrivate": true,
  "excludeProtected": true,
  "excludeExternals": true,
  "hideGenerator": true,
  "sort": ["source-order"],
  "kindSortOrder": [
    "Document",
    "Project",
    "Module",
    "Namespace",
    "Enum",
    "Class",
    "Interface",
    "TypeAlias",
    "Constructor",
    "Property",
    "Variable",
    "Function",
    "Accessor",
    "Method"
  ],
  "categorizeByGroup": true,
  "defaultCategory": "Other",
  "categoryOrder": [
    "Classes",
    "Interfaces",
    "Types",
    "Functions",
    "Variables",
    "*"
  ],
  "gitRevision": "main",
  "gitRemote": "origin",
  "includeVersion": true,
  "validation": {
    "notExported": true,
    "invalidLink": true,
    "notDocumented": false
  },
  "treatWarningsAsErrors": false,
  "skipErrorChecking": false,
  "cleanOutputDir": true,
  "searchInComments": true,
  "searchInDocuments": true,
  "blockTags": [
    "@fileoverview",
    "@version",
    "@author",
    "@license",
    "@param",
    "@returns",
    "@throws",
    "@example",
    "@see",
    "@since",
    "@deprecated"
  ]
}