markmv/typedoc.json at main · ExaDev/markmv · 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
{
  "$schema": "https://typedoc.org/schema.json",
  "categorizeByGroup": false,
  "categoryOrder": [
    "Commands",
    "Core",
    "Strategies",
    "Types",
    "Utilities",
    "*"
  ],
  "defaultCategory": "Other",
  "entryPoints": [
    "src/index.ts"
  ],
  "excludeExternals": true,
  "excludeInternal": true,
  "excludePrivate": true,
  "favicon": "docs-src/assets/favicon.svg",
  "hostedBaseUrl": "https://exadev.github.io/markmv/",
  "includeVersion": true,
  "name": "markmv",
  "navigation": {
    "includeCategories": true,
    "includeFolders": false,
    "includeGroups": false
  },
  "navigationLinks": {
    "Changelog": "https://github.com/ExaDev/markmv/blob/main/CHANGELOG.md",
    "GitHub": "https://github.com/ExaDev/markmv",
    "npm": "https://www.npmjs.com/package/markmv"
  },
  "out": "docs",
  "plugin": [
    "./scripts/typedoc-plugin-social-meta.ts"
  ],
  "projectDocuments": [
    "docs-src/guides/*.md",
    "docs-generated/cli/*.md"
  ],
  "readme": "README.md",
  "requiredToBeDocumented": [
    "Class",
    "Constructor",
    "Function",
    "Interface",
    "Method",
    "Property",
    "TypeAlias",
    "Variable"
  ],
  "searchCategoryBoosts": {
    "Commands": 1.5,
    "Core": 1.25
  },
  "searchGroupBoosts": {
    "Classes": 1.5,
    "Functions": 1.25
  },
  "sort": [
    "kind",
    "instance-first",
    "alphabetical"
  ],
  "treatValidationWarningsAsErrors": true,
  "tsconfig": "tsconfig.build.json",
  "useHostedBaseUrlForAbsoluteLinks": true,
  "validation": {
    "invalidLink": true,
    "invalidPath": true,
    "notDocumented": true,
    "notExported": true
  }
}