TypeDoc 配置 #

┌─────────────────────────────────────────────────────────────┐
│                    配置文件优先级                            │
├─────────────────────────────────────────────────────────────┤
│                                                             │
│  1. typedoc.json（推荐）                                    │
│     项目根目录                                              │
│                                                             │
│  2. typedoc.js                                              │
│     JavaScript 格式配置文件                                 │
│                                                             │
│  3. package.json                                            │
│     typedocOptions 字段                                     │
│                                                             │
│  4. tsconfig.json                                           │
│     typedocOptions 字段                                     │
│                                                             │
└─────────────────────────────────────────────────────────────┘

{
  "entryPoints": ["src/index.ts"]
}

{
  "entryPoints": [
    "src/core/index.ts",
    "src/utils/index.ts",
    "src/plugins/index.ts"
  ]
}

{
  "entryPoints": [
    {
      "entryPoint": "src/core/index.ts",
      "displayName": "Core Module"
    },
    {
      "entryPoint": "src/utils/index.ts",
      "displayName": "Utility Functions"
    }
  ]
}

{
  "entryPointStrategy": "resolve"
}

{
  "tsconfig": "./tsconfig.build.json"
}

{
  "compilerOptions": {
    "skipLibCheck": true,
    "noImplicitAny": false
  }
}

{
  "exclude": [
    "node_modules",
    "dist",
    "**/*.test.ts",
    "**/*.spec.ts",
    "src/internal/**"
  ]
}

{
  "externalPattern": [
    "**/node_modules/**",
    "**/vendor/**"
  ]
}

{
  "out": "docs"
}

{
  "json": "docs/api.json"
}

{
  "pretty": true
}

{
  "cleanOutputDir": true
}

{
  "emit": "docs"
}

{
  "name": "My Project API Documentation"
}

{
  "includeVersion": true
}

{
  "readme": "./README.md"
}

{
  "readme": "none"
}

{
  "favicon": "./assets/favicon.ico"
}

{
  "hideGenerator": true
}

{
  "customFooter": "© 2024 My Company"
}

{
  "customFooterHtml": "<p>Built with <a href='https://typedoc.org'>TypeDoc</a></p>"
}

{
  "excludePrivate": true
}

{
  "excludeProtected": false
}

{
  "excludeInternal": true
}

{
  "excludeExternals": true
}

{
  "excludeNotDocumented": true
}

{
  "excludeReferences": true
}

{
  "visibilityFilters": {
    "protected": true,
    "private": false,
    "inherited": true,
    "external": false,
    "@internal": false,
    "@alpha": true
  }
}

{
  "sort": ["source-order"]
}

{
  "sort": ["static-first", "visibility", "alphabetical"]
}

{
  "kindSortOrder": [
    "Reference",
    "Project",
    "Module",
    "Namespace",
    "Enum",
    "EnumMember",
    "Class",
    "Interface",
    "TypeAlias",
    "Function",
    "Variable"
  ]
}

{
  "searchInComments": true
}

{
  "searchInDocuments": true
}

{
  "theme": "default"
}

{
  "lightHighlightTheme": "light-plus"
}

{
  "darkHighlightTheme": "dark-plus"
}

{
  "categorizeByGroup": true
}

{
  "defaultCategory": "Other"
}

{
  "categoryOrder": [
    "Core",
    "Utilities",
    "Helpers",
    "*"
  ]
}

{
  "groupOrder": [
    "Classes",
    "Interfaces",
    "Functions",
    "Variables",
    "*"
  ]
}

{
  "navigation": {
    "includeCategories": true,
    "includeGroups": true,
    "compactFolders": true
  }
}

{
  "navigationLinks": {
    "GitHub": "https://github.com/user/repo",
    "NPM": "https://www.npmjs.com/package/my-package"
  }
}

{
  "sidebarLinks": {
    "API Reference": "/api",
    "Examples": "/examples"
  }
}

{
  "commentStyle": "jsdoc"
}

{
  "useTsLinkResolution": true
}

{
  "plugin": [
    "typedoc-plugin-markdown",
    "typedoc-theme-hierarchy"
  ]
}

{
  "plugin": []
}

npx typedoc --watch

npx typedoc --watch --preserveWatchOutput

npx typedoc --serve

{
  "host": "localhost"
}

{
  "port": 3000
}

{
  "$schema": "https://typedoc.org/schema.json",
  "entryPoints": ["src/index.ts"],
  "out": "docs",
  "name": "My Library",
  "includeVersion": true,
  "readme": "./README.md",
  "excludePrivate": true,
  "excludeInternal": true,
  "excludeExternals": true,
  "hideGenerator": false,
  "searchInComments": true,
  "sort": ["source-order"],
  "navigationLinks": {
    "GitHub": "https://github.com/user/my-library",
    "NPM": "https://www.npmjs.com/package/my-library"
  },
  "visibilityFilters": {
    "protected": true,
    "private": false,
    "inherited": true,
    "external": false
  }
}

{
  "$schema": "https://typedoc.org/schema.json",
  "entryPoints": [
    "src/core/index.ts",
    "src/api/index.ts",
    "src/utils/index.ts"
  ],
  "out": "docs/api",
  "name": "Enterprise API Documentation",
  "includeVersion": true,
  "favicon": "./docs/assets/favicon.ico",
  "customFooter": "© 2024 Enterprise Inc.",
  "hideGenerator": true,
  "exclude": [
    "**/*.test.ts",
    "**/*.spec.ts",
    "src/internal/**"
  ],
  "excludePrivate": true,
  "excludeProtected": false,
  "excludeInternal": true,
  "sort": ["static-first", "visibility", "alphabetical"],
  "categoryOrder": ["Public API", "Internal", "*"],
  "navigationLinks": {
    "Dashboard": "/dashboard",
    "API Status": "/status"
  },
  "theme": "default",
  "lightHighlightTheme": "github-light",
  "darkHighlightTheme": "github-dark"
}

{
  "$schema": "https://typedoc.org/schema.json",
  "entryPointStrategy": "packages",
  "entryPoints": [
    "packages/core",
    "packages/utils",
    "packages/cli",
    "packages/plugins"
  ],
  "out": "docs",
  "name": "Monorepo Documentation",
  "includeVersion": true,
  "excludePrivate": true,
  "excludeInternal": true,
  "sort": ["source-order"],
  "visibilityFilters": {
    "protected": true,
    "private": false,
    "inherited": true,
    "external": false
  },
  "searchInComments": true,
  "cleanOutputDir": true
}

// typedoc.base.json
{
  "excludePrivate": true,
  "excludeInternal": true,
  "sort": ["source-order"]
}

// typedoc.json
{
  "extends": ["./typedoc.base.json"],
  "entryPoints": ["src/index.ts"],
  "out": "docs",
  "name": "My Project"
}

# 覆盖输出目录
npx typedoc --out custom-docs

# 覆盖多个选项
npx typedoc --out docs --name "Custom Name" --excludePrivate false

# 使用配置文件并覆盖
npx typedoc --options typedoc.prod.json --out production-docs