Sourced from typedoc's releases.
v0.25.0
Breaking Changes
- Bump minimum Node version to 16.
- Removed
legacy-packages
option for--entryPointStrategy
.- Changed default value of
--categorizeByGroup
tofalse
.- Specifying a link as the
gitRemote
is no longer supported.- An
Application
instance must now be retrieved viaApplication.bootstrap
orApplication.bootstrapWithPlugins
, #2268.- Removed
ReflectionKind.ObjectLiteral
that was never used by TypeDoc.- Removed deprecated members
DefaultThemeRenderContext.comment
andDefaultThemeRenderContext.attemptExternalResolution
.Features
- Added support for TypeScript 5.2
- TypeDoc config files now support options default-exported from an ESM config file, #2268.
- TypeDoc config files may now export a promise containing configuration, #2268.
- Added
--preserveLinkText
option (defaults to true) which determines whether the reflection name or full link text is included in the output when no override is specified, #2355.- Added a no-results placeholder when no search results are available, #2347.
- Implemented several miscellaneous performance improvements to generate docs faster, this took the time to generate TypeDoc's site from ~5.6 seconds to ~5.4 seconds.
- Added
--disableGit
option to prevent TypeDoc from using Git to try to determine if sources can be linked, #2326.- Added support for tags
@showGroups
,@hideGroups
,@showCategories
,@hideCategories
to configure the navigation pane on a per-reflection basis, #2329.- With
--jsDocCompatibility.defaultTags
set,@defaultValue
is now implicitly a code block if the text contains no code, #2370.Bug Fixes
- Fixed link discovery if nested (
Foo#bar
) links were used and--useTsLinkResolution
is enabled in some cases, #2360.- Links with invalid declaration references will no longer silently link to the wrong page in some cases, #2360.
- Fixed duplicate definitions in type hierarchy when using packages mode, #2327.
@inheritDoc
was not properly resolved across packages in packages mode, #2331.- Added warning for attempted
@interface
use on union types, #2352.- Fixed misleading type annotation on
Theme.getUrls
, #2318.- Fixed duplicate namespace in documentation if
@namespace
is used on a variable with an associated namespace, #2364.- Fixed
@namespace
property discovery if merged with a type and the type was declared first #2364.- Tables in markdown are now styled, #2366.
- Sidebar links no longer open in a new tab, #2353.
- Headers now include some padding before rendering text, #2316.
- Symbol locations for signatures on
reflection.sources
now considers the node's name like non-signature location discovery does.Thanks!
Sourced from typedoc's changelog.
v0.25.0 (2023-08-25)
Breaking Changes
- Bump minimum Node version to 16.
- Removed
legacy-packages
option for--entryPointStrategy
.- Changed default value of
--categorizeByGroup
tofalse
.- Specifying a link as the
gitRemote
is no longer supported.- An
Application
instance must now be retrieved viaApplication.bootstrap
orApplication.bootstrapWithPlugins
, #2268.- Removed
ReflectionKind.ObjectLiteral
that was never used by TypeDoc.- Removed deprecated members
DefaultThemeRenderContext.comment
andDefaultThemeRenderContext.attemptExternalResolution
.Features
- Added support for TypeScript 5.2, #2373.
- TypeDoc config files now support options default-exported from an ESM config file, #2268.
- TypeDoc config files may now export a promise containing configuration, #2268.
- Added
--preserveLinkText
option (defaults to true) which determines whether the reflection name or full link text is included in the output when no override is specified, #2355.- Added a no-results placeholder when no search results are available, #2347.
- Implemented several miscellaneous performance improvements to generate docs faster, this took the time to generate TypeDoc's site from ~5.6 seconds to ~5.4 seconds.
- Added
--disableGit
option to prevent TypeDoc from using Git to try to determine if sources can be linked, #2326.- Added support for tags
@showGroups
,@hideGroups
,@showCategories
,@hideCategories
to configure the navigation pane on a per-reflection basis, #2329.- With
--jsDocCompatibility.defaultTags
set,@defaultValue
is now implicitly a code block if the text contains no code, #2370.Bug Fixes
- Fixed link discovery if nested (
Foo#bar
) links were used and--useTsLinkResolution
is enabled in some cases, #2360.- Links with invalid declaration references will no longer silently link to the wrong page in some cases, #2360.
- Fixed duplicate definitions in type hierarchy when using packages mode, #2327.
@inheritDoc
was not properly resolved across packages in packages mode, #2331.- Added warning for attempted
@interface
use on union types, #2352.- Fixed misleading type annotation on
Theme.getUrls
, #2318.- Fixed duplicate namespace in documentation if
@namespace
is used on a variable with an associated namespace, #2364.- Fixed
@namespace
property discovery if merged with a type and the type was declared first #2364.- Tables in markdown are now styled, #2366.
- Sidebar links no longer open in a new tab, #2353.
- Headers now include some padding before rendering text, #2316.
- Symbol locations for signatures on
reflection.sources
now considers the node's name like non-signature location discovery does.Thanks!
8d822e9
Update changelog for releasefc6f648
Bump version to 0.25.0d4db571
Add preserveLinkText option3d8ff29
defaultValue is implicitly code only with JSDoc compat028a141
feat(default-value): treat as code block for better styling (#2370)c83f2c3
Add support for TS 5.25c977ae
Support ESM config files76c918c
Headers now include some padding before rendering text0cc6e58
Sidebar links no longer open in a new tab, closes #2353.3207ae5
Lint