Improve detection for legacy JSDoc @example tags, #2222.
The page footer will now appear at the bottom of the page even if the page is short, #2223.
v0.24.0
Breaking Changes
@link, @linkcode and @linkplain tags will now be resolved with TypeScript's link resolution by default. The useTsLinkResolution option
can be used to turn this behavior off, but be aware that doing so will mean your links will be resolved differently by editor tooling and TypeDoc.
TypeDoc will no longer automatically load plugins from node_modules. Specify the --plugin option to indicate which modules should be loaded.
The packages entry point strategy will now run TypeDoc in each provided package directory and then merge the results together.
The previous packages strategy has been preserved under legacy-packages and will be removed in 0.25. If the new strategy does not work
for your use case, please open an issue.
Removed --logger option, to disable all logging, set the logLevel option to none.
Dropped support for legacy [[link]]s, removed deprecated Reflection.findReflectionByName.
Added @overload to default ignored tags.
API Breaking Changes
The label property on Reflection has moved to Comment.
The default value of the out option has been changed from "" to "./docs", #2195.
Renamed DeclarationReflection#version to DeclarationReflection#projectVersion to match property on ProjectReflection.
Removed unused Reflection#originalName.
Removed Reflection#kindString, use ReflectionKind.singularString(reflection.kind) or ReflectionKind.pluralString(reflection.kind) instead.
The named-tuple-member and template-literal type kind have been replaced with namedTupleMember and templateLiteral, #2100.
Properties related to rendering are no longer stored on Reflection, including url, anchor, hasOwnDocument, and cssClasses.
Application.bootstrap will no longer load plugins. If you want to load plugins, use Application.bootstrapWithPlugins instead, #1635.
The options passed to Application.bootstrap will now be applied both before and after reading options files, which may cause a change in configuration
if using a custom script to run TypeDoc that includes some options, but other options are set in config files.
Moved sources property previously declared on base Reflection class to DeclarationReflection and SignatureReflection.
Moved relevanceBoost from ContainerReflection to DeclarationReflection since setting it on the parent class has no effect.
Removed internal ReferenceType.getSymbol, reference types no longer reference the ts.Symbol to enable generation from serialized JSON.
OptionsReader.priority has been renamed to OptionsReader.order to more accurately reflect how it works.
ReferenceTypes which point to type parameters will now always be intentionally broken since they were never linked and should not be warned about when validating exports.
ReferenceTypes now longer include an id property for their target. They now instead include a target property.
Removed Renderer.addExternalSymbolResolver, use Converter.addExternalSymbolResolver instead.
Removed CallbackLogger.
Removed SerializeEventData from serialization events.
A PageEvent is now required for getRenderContext. If caching the context object, page must be updated when getRenderContext is called.
PageEvent no longer includes the template property. The Theme.render method is now expected to take the template to render the page with as its second argument.
Removed secondaryNavigation member on DefaultThemeRenderContext.
Renamed navigation to sidebar on DefaultThemeRenderContext and navigation.begin/navigation.end hooks to sidebar.begin/sidebar.end.
Features
Added --useTsLinkResolution option (on by default) which tells TypeDoc to use TypeScript's @link resolution.
Improve detection for legacy JSDoc @example tags, #2222.
The page footer will now appear at the bottom of the page even if the page is short, #2223.
v0.24.0 (2023-04-08)
Breaking Changes
@link, @linkcode and @linkplain tags will now be resolved with TypeScript's link resolution by default. The useTsLinkResolution option
can be used to turn this behavior off, but be aware that doing so will mean your links will be resolved differently by editor tooling and TypeDoc.
TypeDoc will no longer automatically load plugins from node_modules. Specify the --plugin option to indicate which modules should be loaded.
The packages entry point strategy will now run TypeDoc in each provided package directory and then merge the results together.
The previous packages strategy has been preserved under legacy-packages and will be removed in 0.25. If the new strategy does not work
for your use case, please open an issue.
Removed --logger option, to disable all logging, set the logLevel option to none.
Dropped support for legacy [[link]]s, removed deprecated Reflection.findReflectionByName.
Added @overload to default ignored tags.
API Breaking Changes
The label property on Reflection has moved to Comment.
The default value of the out option has been changed from "" to "./docs", #2195.
Renamed DeclarationReflection#version to DeclarationReflection#projectVersion to match property on ProjectReflection.
Removed unused Reflection#originalName.
Removed Reflection#kindString, use ReflectionKind.singularString(reflection.kind) or ReflectionKind.pluralString(reflection.kind) instead.
The named-tuple-member and template-literal type kind have been replaced with namedTupleMember and templateLiteral, #2100.
Properties related to rendering are no longer stored on Reflection, including url, anchor, hasOwnDocument, and cssClasses.
Application.bootstrap will no longer load plugins. If you want to load plugins, use Application.bootstrapWithPlugins instead, #1635.
The options passed to Application.bootstrap will now be applied both before and after reading options files, which may cause a change in configuration
if using a custom script to run TypeDoc that includes some options, but other options are set in config files.
Moved sources property previously declared on base Reflection class to DeclarationReflection and SignatureReflection.
Moved relevanceBoost from ContainerReflection to DeclarationReflection since setting it on the parent class has no effect.
Removed internal ReferenceType.getSymbol, reference types no longer reference the ts.Symbol to enable generation from serialized JSON.
OptionsReader.priority has been renamed to OptionsReader.order to more accurately reflect how it works.
ReferenceTypes which point to type parameters will now always be intentionally broken since they were never linked and should not be warned about when validating exports.
ReferenceTypes now longer include an id property for their target. They now instead include a target property.
Removed Renderer.addExternalSymbolResolver, use Converter.addExternalSymbolResolver instead.
Removed CallbackLogger.
Removed SerializeEventData from serialization events.
A PageEvent is now required for getRenderContext. If caching the context object, page must be updated when getRenderContext is called.
PageEvent no longer includes the template property. The Theme.render method is now expected to take the template to render the page with as its second argument.
Removed secondaryNavigation member on DefaultThemeRenderContext.
Renamed navigation to sidebar on DefaultThemeRenderContext and navigation.begin/navigation.end hooks to sidebar.begin/sidebar.end.
Features
Added --useTsLinkResolution option (on by default) which tells TypeDoc to use TypeScript's @link resolution.
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 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.23.28 to 0.24.1.
Release notes
Sourced from typedoc's releases.
... (truncated)
Changelog
Sourced from typedoc's changelog.
... (truncated)
Commits
16cc385Update changelog for release6b32dabBump version to 0.24.10e3a892Some cleanup from 0.24.0a6e6544Reorder option declarations to match docs7a696aeUpdate changelog for release4a762acBump version to 0.24.029069e0Merge pull request #2210 from TypeStrong/beta27f550fFix broken links in example0c105ecOne last bugfix864db57Add jsDocCompatibility optionDependabot 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 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)