Removed legacy-packages option for --entryPointStrategy.
Changed default value of --categorizeByGroup to false.
Specifying a link as the gitRemote is no longer supported.
An Application instance must now be retrieved via Application.bootstrap or Application.bootstrapWithPlugins, #2268.
Removed ReflectionKind.ObjectLiteral that was never used by TypeDoc.
Removed deprecated members DefaultThemeRenderContext.comment and DefaultThemeRenderContext.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.
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.
Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.
Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it
- `@dependabot merge` will merge this PR after your CI passes on it
- `@dependabot squash and merge` will squash and merge this PR after your CI passes on it
- `@dependabot cancel merge` will cancel a previously requested merge and block automerging
- `@dependabot reopen` will reopen this PR if it is closed
- `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
- `@dependabot show ignore conditions` will show all of the ignore conditions of the specified dependency
- `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
- `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
- `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)
Bumps typedoc from 0.24.8 to 0.25.0.
Release notes
Sourced from typedoc's releases.
Changelog
Sourced from typedoc's changelog.
Commits
8d822e9Update changelog for releasefc6f648Bump version to 0.25.0d4db571Add preserveLinkText option3d8ff29defaultValue is implicitly code only with JSDoc compat028a141feat(default-value): treat as code block for better styling (#2370)c83f2c3Add support for TS 5.25c977aeSupport ESM config files76c918cHeaders now include some padding before rendering text0cc6e58Sidebar links no longer open in a new tab, closes #2353.3207ae5LintDependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting
@dependabot rebase.Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot merge` will merge this PR after your CI passes on it - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it - `@dependabot cancel merge` will cancel a previously requested merge and block automerging - `@dependabot reopen` will reopen this PR if it is closed - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - `@dependabot show