typedoc.json

{
  "$schema": "https://typedoc-plugin-markdown.org/schema.json",
  "disableSources": true,
  "out": "./docs",
  "entryPoints": ["src/modules/*/index.ts"],
  "sort": ["kind", "source-order"],
  "plugin": [
    "typedoc-plugin-zod",
    "typedoc-plugin-markdown",
    "typedoc-plugin-remark",
    "./customTheme.mjs"
  ],
  "cleanOutputDir": true,
  "indexFormat": "list",
  "parametersFormat": "table",
  "interfacePropertiesFormat": "list",
  "classPropertiesFormat": "list",
  "enumMembersFormat": "table",
  "typeDeclarationFormat": "list",
  "propertyMembersFormat": "table",

  "expandParameters": true,
  "expandObjects": true,

  "categoryOrder": ["Controller", "*"],

  "hideBreadcrumbs": true,
  "hidePageHeader": true,
  "hidePageTitle": true,
  "hideGroupHeadings": true,

  "treatWarningsAsErrors": true,

  // don't enable this, because it breaks references to some types on some pages,
  // even though it gives us nice syntax highlighting.
  "useCodeBlocks": false,

  "tableColumnSettings": {
    "hideInherited": true,
    "hideDefaults": false
  },

  "outputFileStrategy": "members",
  "flattenOutputFiles": false,
  "theme": "customTheme",
  "readme": "./src/docs_api_readme_prepend.md",
  "mergeReadme": true
}