mcp-ext-apps/typedoc.config.mjs at main · jonathanhefner/mcp-ext-apps · 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
import { OptionDefaults } from "typedoc";

/** @type {Partial<import('typedoc').TypeDocOptions>} */
const config = {
  name: "MCP Apps",
  readme: "README.md",
  headings: {
    readme: false,
  },
  gitRevision: "main",
  projectDocuments: [
    "docs/overview.md",
    "docs/quickstart.md",
    "docs/agent-skills.md",
    "docs/testing-mcp-apps.md",
    "docs/patterns.md",
    "docs/authorization.md",
    "docs/csp-cors.md",
    "docs/migrate_from_openai_apps.md",
  ],
  entryPoints: [
    "src/server/index.ts",
    "src/app.ts",
    "src/react/index.tsx",
    "src/app-bridge.ts",
    "src/message-transport.ts",
    "src/types.ts",
  ],
  excludePrivate: true,
  excludeInternal: false,
  intentionallyNotExported: ["AppOptions"],
  blockTags: [...OptionDefaults.blockTags, "@description"],
  jsDocCompatibility: {
    exampleTag: false,
  },
  includeVersion: false,
  categorizeByGroup: true,
  groupOrder: ["Getting Started", "Security", "Modules", "*"],
  navigation: {
    includeGroups: true,
  },
  navigationLinks: {
    GitHub: "https://github.com/modelcontextprotocol/ext-apps",
    Specification:
      "https://github.com/modelcontextprotocol/ext-apps/blob/main/specification/2026-01-26/apps.mdx",
  },
  hostedBaseUrl: "https://apps.extensions.modelcontextprotocol.io/api/",
  customCss: "./docs/mcp-theme.css",
  out: "docs/api",
  plugin: [
    "typedoc-github-theme",
    "./scripts/typedoc-plugin-fix-mermaid-entities.mjs",
    "./scripts/typedoc-plugin-seo.mjs",
    "./scripts/typedoc-plugin-mcpstyle.mjs",
    "@boneskull/typedoc-plugin-mermaid",
  ],
  ignoredHighlightLanguages: ["mermaid"],
  locales: {
    en: {
      kind_plural_document: "Getting Started",
      kind_plural_module: "API Documentation",
    },
  },
};

export default config;