Use typedoc-github-theme for API documentation

Configure TypeDoc to use the GitHub-styled theme for better visual
consistency with the project's GitHub presence. Also reorganize the
config options and enable group navigation for improved documentation
structure.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This commit is contained in:
Jonathan Hefner 2026-01-22 13:23:48 -06:00
commit eb803723ef
No known key found for this signature in database
GPG key ID: 0DA40AFD21043691

View file

@ -2,8 +2,11 @@ import { OptionDefaults } from "typedoc";
/** @type {Partial<import('typedoc').TypeDocOptions>} */
const config = {
blockTags: [...OptionDefaults.blockTags, "@description"],
intentionallyNotExported: ["AppOptions"],
readme: "README.md",
headings: {
readme: false,
},
gitRevision: "main",
projectDocuments: [
"docs/quickstart.md",
"docs/patterns.md",
@ -17,21 +20,25 @@ const config = {
"src/message-transport.ts",
"src/types.ts",
],
out: "docs/api",
gitRevision: "main",
excludePrivate: true,
excludeInternal: false,
intentionallyNotExported: ["AppOptions"],
blockTags: [...OptionDefaults.blockTags, "@description"],
jsDocCompatibility: {
exampleTag: false,
},
includeVersion: true,
categorizeByGroup: true,
navigation: {
includeGroups: true,
},
navigationLinks: {
GitHub: "https://github.com/modelcontextprotocol/ext-apps",
Specification:
"https://github.com/modelcontextprotocol/ext-apps/blob/main/specification/draft/apps.mdx",
},
readme: "README.md",
includeVersion: true,
out: "docs/api",
plugin: ["typedoc-github-theme"],
};
export default config;