npm / typedoc
typedoc
What changed in typedoc 0.28, from its official release notes, upgrade guides and advisories. Sources checked 2026-10-18.
1 breaking4 new APIs and options1 behavior and defaults1 tooling7 fixes and other
See which of these apply to your code, ranked, in your agent:
npx @unstale/cli inittypedoc 0.2814 changes
Breaking changes 1
TypeDoc no longer includes this information, avoiding cases where it inferred the wrong path when resolving base paths for display.
New APIs and options 4
TS-in-JS @typedef comments can use inline modifier tags, making it possible to add modifier tags to these members.
Accepts the special value {branch} to use the current git branch for source links.
Provides logging for validation that occurs during conversion rather than during TypeDoc's normal validation step.
Suppresses warnings caused by referencing relative paths that do not exist when building the documentation.
Behavior and default changes 1
Added support for regions in @include references to .tsx, .cjs, and .mjs files.
Tooling 1
A JSON schema for TypeDoc configuration is included in the package root, and the latest schema is published at typedoc.org/schema.json for automatic use when writing typedoc.json files in VSCode.
Fixes and other changes 7
Fixed anchor link generation for members named $.
Improved handling of comments for type aliases that have been declaration merged with functions.
Unused @param tag warnings from declaration files are now properly suppressed when this option is enabled.
Fixed an issue preventing automatic entry point discovery on Windows.
Fixed an issue causing TypeDoc to fail to generate documentation when implementing interfaces.
Adjusted markdown rendering to allow markdownItLoader to override more rendering.
Improved the vertical positioning of text icons.