nexus/typedoc.config.mjs at main · audiotool/nexus · 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
import pkg from "./package.json" with { type: "json" }

// derive entry points from package.json `exports` field
const entryPoints = Object.keys(pkg.exports).map((key) => {
  const name = key === "." ? "index" : key.slice(2)
  return `src/exports/${name}.ts`
})

/** @type {Partial<import("typedoc").TypeDocOptions>} */
const config = {
  entryPoints,
  sortEntryPoints: false,
  out: "docs",
  plugin: [
    // "typedoc-plugin-missing-exports",
    "typedoc-plugin-mdn-links",
    "@8hobbies/typedoc-plugin-plausible",
    "./codegen/typedoc/qualified-link-text.mjs",
    "./codegen/typedoc/llms-markdown-plugin.mjs",
  ],
  navigation: {
    includeCategories: false,
  },
  navigationLinks: {
    "Developer Hub": "https://developer.audiotool.com",
    "Github Repository": "https://github.com/audiotool/nexus",
  },
  readme: "src/docs/index.md",
  projectDocuments: [
    "src/docs/getting-started.md",
    "src/docs/overview.md",
    "src/docs/login.md",
    "src/docs/api.md",
    "src/docs/transaction-errors.md",
    "src/docs/entities.md",
    "src/docs/changelog.md",
  ],
  disableSources: false,
  gitRemote: "origin",
  includeVersion: true,
  searchInComments: true,
  searchInDocuments: true,
  excludePrivate: true,
  excludeInternal: true,
  exclude: ["**/*.test.ts", "**/_*.ts"],
  skipErrorChecking: false,
  validation: {
    notExported: true,
  },
  preserveLinkText: true,
  modifierTags: [
    "@generated",
    "@internal",
    "@alpha",
    "@beta",
    "@experimental",
    "@deprecated",
    "@packageDocumentation",
    "@internalType",
    "@hidden",
  ],
  name: "@audiotool/nexus",
  customCss: "src/docs/style.css",
  // cookie banner with google analytics
  customFooterHtml: `<script type="module">
			(await import('https://cdn.audiotool.com/website-assets/cookie-banner/latest/cookie-banner.js')).banner()
  </script>`,
  // disable wrapping footer
  customFooterHtmlDisableWrapper: true,
  plausibleSiteDomain: "developer.audiotool.com",
}

export default config