Features
- Added
stripYamlFrontmatter
config option to remove YAML frontmatter from README.md, #2381. - Added
--excludeCategories
config option to remove reflections present in any excluded category, #1407. - If no tsconfig.json file is present, TypeDoc will now attempt to compile without setting any compiler options, #2304.
- Navigation is now written to a JS file and built dynamically, which significantly decreases document generation time
with large projects and also provides large space benefits. Themes may now overrideDefaultTheme.buildNavigation
to customize the displayed navigation tree, #2287.
Note: This change rendersnavigation.fullTree
obsolete. If you set it, TypeDoc will warn that it is being ignored.
It will be removed in v0.26. - The search index is now compressed before writing, which reduces most search index sizes by ~5-10x.
- TypeDoc will now attempt to cache icons when
DefaultThemeRenderContext.icons
is overwritten by a custom theme.
Note: To perform this optimization, TypeDoc relies onDefaultThemeRenderContext.iconCache
being rendered within
each page. TypeDoc does it in thedefaultLayout
template. - Cache URL derivation during generation, #2386.
Bug Fixes
@property
now works as expected if used to override a method's documentation.- Deprecated functions/methods are now correctly rendered with a struck-out name.
--watch
mode works again, #2378.- Improved support for optional names within JSDoc types, #2384.
- Fixed duplicate rendering of reflection flags on signature parameters, #2385.
- TypeDoc now handles the
intrinsic
keyword if TS intrinsic types are included in documentation. --exclude
is now respected when expanding globs in entry points, #2376.