You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Added navigation.fullTree to control rendering the full navigation tree on each page, #2287.
This option will likely be replaced in 0.25 with dynamic loading of the full tree.
TypeDoc's --pretty option now also controls whether generated HTML contains line breaks, #2287.
Optimized icon caching to reduce file size in generated HTML documentation, #2287.
Render property description of "roughly top level" object types, #2276.
When rendering functions/methods, TypeDoc will now render the comment summary above the parameters/return type,
and any other block tags in the order they are defined in the comment, #2285.
Comments are no longer removed from classes/interfaces containing call signatures, #2290.
Improved error messaging if a provided entry point could not be converted into a documented module reflection, #2242.
API: Added support for g, circle, ellipse, polygon, and polyline svg elements, #2259.
Extended jsDocCompatibility option with inheritDocTag to ignore fully lowercase inheritDoc tags and ignoreUnescapedBraces to disable warnings about unescaped { and } characters in comments.
Bug Fixes
--useTsLinkResolution is no longer ignored within block tags, #2260.
The current namespace will also be expanded in the navigation on page load, #2260.
Fixed flicker of navigation pane when reloading a page caused by updating expansion state after the page was loaded.
Fixed an infinite loop if more than one entry point was provided, and all entry points were the same.
Categories and groups can now be shown in the navigation, added --navigation.includeCategories
and --navigation.includeGroups to control this behavior. The --categorizeByGroup option also
effects this behavior. If categorizeByGroup is set (the default) and navigation.includeGroups is not set, the value of navigation.includeCategories will be effectively ignored since categories
will be created only within groups, #1532.
Added support for discovering a "module" comment on global files, #2165.
Added semantic link coloring for reflection names & links, #2227.
Note: This resulted in function signatures becoming too busy for easy scanning with even slightly
complicated signatures as such, TypeDoc now only renders parameter names in the signature title
and includes the type in the parameter details as usual. This can be controlled with the new --hideParameterTypesInTitle option.
Conditional types will now render their branches on the next line for easier comprehension.
Bug Fixes
Fixed & showing as & and HTML text showing up in page contents navigation, #2224.
Increased padding between sections when one navigation column is displayed, #2225.
Correct padding for navigation elements with a displayed icon, #2229.
Fixed source-order sort strategy failing to compare reflections within a file.
Added enum-member-source-order specialization of the source-order sort strategy which only compares enum members, #2237.
Updated highlight colors for semantic links to meet WCAG AA contrast requirements, #2228.
Type parameters are now highlighted consistently, #2230.
Fixed semantic coloring in type and function signatures, #2227.
Fixed issue where removing a reflection indirectly containing an object/function type would only partially remove the reflection, #2231.
Fixed "Implementation of X.y" links if a mixture of methods and property-methods are used, #2233.
"Implementation of" text to symbol-properties not contained in the documentation will now use the resolved name instead of a __@​ symbol name, #2234.
Fix expansion of globs if a single entry point is provided, #2235.
Validation will no longer be skipped for sub packages when running with --entryPointStrategy packages.
Fixed broken theme toggle if the page contained a member named "theme".
@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.
Added --jsDocCompatibility option (on by default) which controls TypeDoc's automatic detection of code blocks in @example and @default tags.
Reworked default theme navigation to add support for a page table of contents, #1478, #2189.
Added support for @interface on type aliases to tell TypeDoc to convert the fully resolved type as an interface, #1519
Added support for @namespace on variable declarations to tell TypeDoc to convert the variable as a namespace, #2055.
Added support for @prop/@property to specify documentation for a child property of a symbol, intended for use with @interface.
TypeDoc will now produce more informative error messages for options which cannot be set from the cli, #2022.
TypeDoc will now attempt to guess what option you may have meant if given an invalid option name.
Plugins may now return a Promise<void> from their load function, #185.
TypeDoc now supports plugins written with ESM, #1635.
Added Renderer.preRenderAsyncJobs and Renderer.postRenderAsyncJobs, which may be used by plugins to perform async processing for rendering, #185.
Note: Conversion is still intentionally a synchronous process to ensure stability of converted projects between runs.
TypeDoc options may now be set under the typedocOptions key in package.json, #2112.
Added --cacheBust option to tell TypeDoc to include include the generation time in files, #2124.
Added --excludeReferences option to tell TypeDoc to omit re-exports of a symbol already included from the documentation.
Introduced new render hooks pageSidebar.begin and pageSidebar.end.
Bug Fixes
TypeDoc will now ignore package.json files not containing a name field, #2190.
Fixed @inheritDoc on signatures (functions, methods, constructors, getters, setters) being unable to inherit from a non-signature.
Interfaces/classes created via extending a module will no longer contain variables/functions where the member should have been converted as properties/methods, #2150.
TypeDoc will now ignore a leading v in versions, #2212.
Category titles now render with the same format in the page index and heading title, #2196.
Fixed crash when using typeof on a reference with type arguments, #2220.
Fixed broken anchor links generated to signatures nested within objects.
Upgraded Shiki, if your highlight theme was set to material-<theme>, the value will need to be changed to material-theme-<theme>, see the Shiki release notes.
Features
Added new excludeNotDocumentedKinds variable to control which reflection types can be removed
by the excludeNotDocumented option, #2162.
Added typedoc.jsonc, typedoc.config.js, typedoc.config.cjs, typedoc.cjs to the list of files
which TypeDoc will automatically use as configuration files.
Bug Fixes
Entry points under node_modules will no longer be ignored, #2151.
Corrected behavior of excludeNotDocumented on arrow function-variables, #2156.
Improved error reporting when failing to find entry points, #2080, #2082.
Bug Fixes
Constructor parameter-properties will now use the @param comment for the parameter if available, #1261.
Fixed display of object types containing methods, #1788.
Fixed conversion of intrinsic string mapping types when converting without a type node, #2079.
v0.23.17 (2022-10-18)
Features
Added titleLink, navigationLinks and sidebarLinks options to add additional links to the rendered output, #1830.
Added sourceLinkTemplate option to allow more flexible specification of remote urls.
Deprecated now redundant gitRevision detection starting with https?:// introduced in v0.23.16, #2068.
TypeDoc will now treat @typedef {import("foo").Bar<Z>} Baz type declarations which forward type parameters to the imported
symbol as re-exports of that symbol, #2044.
Bug Fixes
TypeDoc will now prefer comments on variable declarations over signature comments, #2042.
Fixed double rendering of "Type Parameters" header, #2054.
Fixed double rendering of "Hierarchy" header, #2053.
Removed unused widgets.png and [email protected] files from generated assets folder.
v0.23.14 (2022-09-03)
Features
Added support for defining one-off external link mappings with externalSymbolLinkMappings see the documentation for usage examples and caveats, #2030.
External link resolvers defined with addUnknownSymbolResolver will now be checked when resolving @link tags, #2030.
Note: To support this, resolution will now happen during conversion, and as such, Renderer.addUnknownSymbolResolver has been
soft deprecated in favor of Converter.addUnknownSymbolResolver. Plugins should update to use the method on Converter. DefaultThemeRenderContext.attemptExternalResolution has also been deprecated since it will repeat work done during conversion,
use ReferenceType.externalUrl instead.
Added Converter.addUnknownSymbolResolver for use by plugins supporting external links.
Bug Fixes
Fixed conversion of object literal types containing construct signatures, #2036.
Fixed centering of title bar on wide displays, actually this time, #2046.
v0.23.13 (2022-09-01)
Bug Fixes
Fixed packages mode bug introduced in 0.23.12, #2043.
v0.23.12 (2022-08-31)
Features
Added a new ParameterType.Object for declaring object options which will be shallowly merged when read from user configuration.
Added a new Application.EVENT_BOOTSTRAP_END event emitted when Application.bootstrap is called.
Bug Fixes
TypeDoc will now work properly in packages mode when converting packages outside the current working directory, #2043.
Fixed deprecation warning for isIdentifierOrPrivateIdentifier.
Fixed centering of title bar on wide displays, #2046.
Introduced a skipErrorChecking option which instructs TypeDoc to not ask TypeScript for compiler errors
before attempting to generate documentation. Turning this on may improve generation speed, but could also
cause a crash if your code contains compiler errors.
Added support for JS entry points when using packages mode, #2037.
Bug Fixes
Fixed crash when converting abstract mixin class, #2011.
Readme files within monorepos now have @link tags resolved, #2029.
Correctly resolve unqualified links to class members within parameters, #2031.
TypeDoc will now consider other reflections with the same name as parents when resolving links, #2033.
The "Hierarchy" and "Type Parameters" helpers on DefaultThemeRenderContext now contain all the HTML for their sections of the page, #2038.
TypeDoc will no longer skip entry points which have no exports, #2007.
If using "entryPointStrategy": "expand", this change may result in new pages being added to your documentation.
If this is not desired, you can use the exclude option to filter them out.
Fixed missing comments on callable variable-functions constructed indirectly, #2008.
Packages mode will now respect the --includeVersion flag, #2010.
Fixed multiple reflections mapping to the same file name on case insensitive file systems, #2012.
Tags must now contain whitespace after the tag name to be parsed as a tag, @jest/globals in a comment will no longer be parsed as a tag #1990.
The private member visibility option will now be respected in generated sites, #1992.
Overload rendering will no longer be broken if JavaScript is disabled, #453.
All overloads are now shown at once rather than requiring clicks to see the documentation for each signature, #1100.
v0.23.6 (2022-07-08)
Features
Improved support for --entryPointStrategy Packages. TypeDoc will now load package-specific configurations from package.jsontypedoc field. This configuration allows configuring a custom display name (typedoc.displayName) field, entry point (typedoc.entryPoint - this is equivalent and will override typedocMain), and path to a readme file to be rendered at the top of the package page (typedoc.readmeFile), #1658.
The --includeVersion option will now be respected by --entryPointStrategy Packages. Also, for this combination, missing version field in the root package.json will not issue a warning.
The navigation partial will now call the new settings, primaryNavigation, and secondaryNavigation partials, #1987.
Bug Fixes
All warnings will be reported instead of only the first warning of a given type, #1981.
Include references will no longer be incorrectly parsed as links, #1986.
The generated schema.json on the website will now use enum values rather than enum names if possible.
The DEBUG_SEARCH_WEIGHTS global variable can now be set on window to add search scoring information in the search results.
TypeDoc's icons are now available on DefaultThemeRenderContext.icons for use/modification by themes.
v0.23.4 (2022-07-02)
Bug Fixes
TypeDoc no longer ignores project references if --entryPointStrategy Packages is set, #1976.
Boost computations are now done when creating the search index, resulting in a smaller search.js generated file.
Features
The --exclude option will now be respected by --entryPointStrategy Packages and can be used to exclude package directories, #1959.
TypeDoc now emits an IndexEvent on the Renderer when preparing the search index, #1953.
Added new --searchInComments option to include comment text in the search index, #1553.
Turning this option on will increase the size of your search index, potentially by an order of magnitude.
v0.23.3 (2022-07-01)
Bug Fixes
Function properties in type space will no longer be interpreted as methods, #1637.
TypeDoc will no longer crash if a comment contains an empty @example tag, #1967.
TypeDoc will now detect attempted inheritance from accessors and inherit from the getter or setter, #1968.
intentionallyNotExported will now properly respect qualified names, #1972.
Fixed missing namespace comments on export * as NS declarations, #1973.
Fixed missing comments on export const x = () => 123 function variables, #1973.
Exported variable functions with properties will now be converted as a function+namespace instead of a variable+namespace, #1651.
Validation warnings caused by missing documentation will now be formatted like other warnings which reference a declaration.
TypeDoc will no longer warn if both the get and set signatures of an accessor have a comment.
Features
Added --htmlLang option to set the lang attribute in the generated HTML. Defaults to en, #1951.
Added --basePath option to override TypeDoc's detected root directory, #1924.
Added support for TypeDoc specific :getter and :setter meaning keywords in declaration references.
Warnings caused by comment contents will now do a better job of including the location of the text that caused the warning.
v0.23.2 (2022-06-28)
Bug Fixes
Module comments will no longer be inappropriately attached to signatures, #1962.
Projects with a single entry point will now parse @module comments in the entry point, #1963.
Removed duplicate "in comment" warning when parsing comments, #1964.
Reflections with a boost of <= 0 due to searchCategoryBoosts or searchGroupBoosts will be excluded from search.
v0.23.1 (2022-06-26)
Bug Fixes
If a declaration has multiple comments associated with it, the last one should be used, #1961.
Link Height tasks by mentioning a task ID in the pull request title or commit messages, or description and comments with the keyword link (e.g. "Link T-123").
💡Tip: You can also use "Close T-X" to automatically close a task when the pull request is merged.
Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.
This PR includes no changesets
When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types
Because you closed this PR without merging, Renovate will ignore this update (^0.24.0). You will get a PR once a newer version is released. To ignore this dependency forever, add it to the ignoreDeps array of your Renovate config.
If you accidentally closed this PR, or if you changed your mind: rename this PR to get a fresh replacement PR.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
![renovate[bot]](https://avatars.githubusercontent.com/in/2740?s=60&v=4){kind=small}
This PR contains the following updates:
^0.23.27->^0.24.0Release Notes
TypeStrong/TypeDoc (typedoc)
v0.24.8Compare Source
Features
navigation.fullTreeto control rendering the full navigation tree on each page, #2287.This option will likely be replaced in 0.25 with dynamic loading of the full tree.
--prettyoption now also controls whether generated HTML contains line breaks, #2287.MarkdownEvent.INCLUDEfor plugins, #2284.Bug Fixes
and any other block tags in the order they are defined in the comment, #2285.
Thanks!
v0.24.7Compare Source
Features
Bug Fixes
sortoption, #2272.v0.24.6Compare Source
Features
g,circle,ellipse,polygon, andpolylinesvg elements, #2259.jsDocCompatibilityoption withinheritDocTagto ignore fully lowercaseinheritDoctags andignoreUnescapedBracesto disable warnings about unescaped{and}characters in comments.Bug Fixes
--useTsLinkResolutionis no longer ignored within block tags, #2260.Thanks!
v0.24.5Compare Source
Features
--navigation.includeCategoriesand
--navigation.includeGroupsto control this behavior. The--categorizeByGroupoption alsoeffects this behavior. If
categorizeByGroupis set (the default) andnavigation.includeGroupsisnot set, the value of
navigation.includeCategorieswill be effectively ignored since categorieswill be created only within groups, #1532.
@returnsblocks will now be rendered with the return type, #2180.--groupOrderoption to specify the sort order of groups, #2251.Bug Fixes
--hideParameterTypesInTitleoption, #2226.@returnsblock is is present in a function, and ignore the duplicate blocks as specified by TSDoc.Thanks!
v0.24.4Compare Source
Bug Fixes
v0.24.3Compare Source
Bug Fixes
v0.24.2Compare Source
Features
Note: This resulted in function signatures becoming too busy for easy scanning with even slightly
complicated signatures as such, TypeDoc now only renders parameter names in the signature title
and includes the type in the parameter details as usual. This can be controlled with the new
--hideParameterTypesInTitleoption.Bug Fixes
&showing as&and HTML text showing up in page contents navigation, #2224.source-ordersort strategy failing to compare reflections within a file.enum-member-source-orderspecialization of thesource-ordersort strategy which only compares enum members, #2237.__@​symbol name, #2234.--entryPointStrategy packages.Thanks!
v0.24.1Compare Source
Bug Fixes
@exampletags, #2222.v0.24.0Compare Source
Breaking Changes
@link,@linkcodeand@linkplaintags will now be resolved with TypeScript's link resolution by default. TheuseTsLinkResolutionoptioncan 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.
node_modules. Specify the--pluginoption to indicate which modules should be loaded.packagesentry point strategy will now run TypeDoc in each provided package directory and then merge the results together.The previous
packagesstrategy has been preserved underlegacy-packagesand will be removed in 0.25. If the new strategy does not workfor your use case, please open an issue.
--loggeroption, to disable all logging, set thelogLeveloption tonone.[[link]]s, removed deprecatedReflection.findReflectionByName.@overloadto default ignored tags.API Breaking Changes
labelproperty onReflectionhas moved toComment.outoption has been changed from""to"./docs", #2195.DeclarationReflection#versiontoDeclarationReflection#projectVersionto match property onProjectReflection.Reflection#originalName.Reflection#kindString, useReflectionKind.singularString(reflection.kind)orReflectionKind.pluralString(reflection.kind)instead.named-tuple-memberandtemplate-literaltype kind have been replaced withnamedTupleMemberandtemplateLiteral, #2100.Reflection, includingurl,anchor,hasOwnDocument, andcssClasses.Application.bootstrapwill no longer load plugins. If you want to load plugins, useApplication.bootstrapWithPluginsinstead, #1635.Application.bootstrapwill now be applied both before and after reading options files, which may cause a change in configurationif using a custom script to run TypeDoc that includes some options, but other options are set in config files.
sourcesproperty previously declared on baseReflectionclass toDeclarationReflectionandSignatureReflection.relevanceBoostfromContainerReflectiontoDeclarationReflectionsince setting it on the parent class has no effect.ReferenceType.getSymbol, reference types no longer reference thets.Symbolto enable generation from serialized JSON.OptionsReader.priorityhas been renamed toOptionsReader.orderto 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 anidproperty for their target. They now instead include atargetproperty.Renderer.addExternalSymbolResolver, useConverter.addExternalSymbolResolverinstead.CallbackLogger.SerializeEventDatafrom serialization events.PageEventis now required forgetRenderContext. If caching the context object,pagemust be updated whengetRenderContextis called.PageEventno longer includes thetemplateproperty. TheTheme.rendermethod is now expected to take the template to render the page with as its second argument.secondaryNavigationmember onDefaultThemeRenderContext.navigationtosidebaronDefaultThemeRenderContextandnavigation.begin/navigation.endhooks tosidebar.begin/sidebar.end.Features
--useTsLinkResolutionoption (on by default) which tells TypeDoc to use TypeScript's@linkresolution.--jsDocCompatibilityoption (on by default) which controls TypeDoc's automatic detection of code blocks in@exampleand@defaulttags.@interfaceon type aliases to tell TypeDoc to convert the fully resolved type as an interface, #1519@namespaceon variable declarations to tell TypeDoc to convert the variable as a namespace, #2055.@prop/@propertyto specify documentation for a child property of a symbol, intended for use with@interface.Promise<void>from theirloadfunction, #185.Renderer.preRenderAsyncJobsandRenderer.postRenderAsyncJobs, which may be used by plugins to perform async processing for rendering, #185.Note: Conversion is still intentionally a synchronous process to ensure stability of converted projects between runs.
typedocOptionskey inpackage.json, #2112.--cacheBustoption to tell TypeDoc to include include the generation time in files, #2124.--excludeReferencesoption to tell TypeDoc to omit re-exports of a symbol already included from the documentation.pageSidebar.beginandpageSidebar.end.Bug Fixes
namefield, #2190.@inheritDocon signatures (functions, methods, constructors, getters, setters) being unable to inherit from a non-signature.vin versions, #2212.typeofon a reference with type arguments, #2220.Thanks!
v0.23.28 (2023-03-19)
Features
consttype parameters.@overloadtag.@satisfiestag.v0.23.27 (2023-03-16)
Features
--treatValidationWarningsAsErrorsto treat only validation warnings as errors without treating all warnings as errors, #2199.Bug Fixes
@privateand@protectedtags totypedoc/tsdoc.json, #2187.Thanks!
v0.23.26 (2023-02-26)
Features
Application.EVENT_VALIDATE_PROJECTevent for plugins which implement custom validation, #2183.Comment.displayPartsToMarkdownon for themes overwriting thecommenthelper, #2115.Bug Fixes
export default undefined, #2175.Thanks!
v0.23.25 (2023-02-11)
Breaking Changes
material-<theme>, the value will need to be changed tomaterial-theme-<theme>, see the Shiki release notes.Features
excludeNotDocumentedKindsvariable to control which reflection types can be removedby the
excludeNotDocumentedoption, #2162.typedoc.jsonc,typedoc.config.js,typedoc.config.cjs,typedoc.cjsto the list of fileswhich TypeDoc will automatically use as configuration files.
Bug Fixes
node_moduleswill no longer be ignored, #2151.excludeNotDocumentedon arrow function-variables, #2156.package.jsonto exports declaration.Thanks!
v0.23.24 (2023-01-07)
Bug Fixes
Thanks!
v0.23.23 (2022-12-18)
Features
ts.Signatureto emittedEVENT_CREATE_SIGNATUREevent, #2002.Bug Fixes
src/andsrc/xare specified as entry points,src/will no longer be ignored, #2121.v0.23.22 (2022-12-11)
Features
Bug Fixes
@linktags within lists, #2103.v0.23.21 (2022-11-14)
Features
externalSymbolLinkMappings, #2102.Thanks!
v0.23.20 (2022-11-03)
Bug Fixes
@inheritDocif inheriting from a function type alias, #2087.v0.23.19 (2022-10-28)
Bug Fixes
titleLinkoption was not specified, #2085.Thanks!
v0.23.18 (2022-10-23)
Features
Bug Fixes
@paramcomment for the parameter if available, #1261.v0.23.17 (2022-10-18)
Features
titleLink,navigationLinksandsidebarLinksoptions to add additional links to the rendered output, #1830.sourceLinkTemplateoption to allow more flexible specification of remote urls.Deprecated now redundant
gitRevisiondetection starting withhttps?://introduced in v0.23.16, #2068.Thanks!
v0.23.16 (2022-10-10)
Features
{ "typedoc": { "tsconfig": "tsconfig.lib.json" }}in package.json, #2061.Bug Fixes
Thanks!
v0.23.15 (2022-09-18)
Features
@typedef {import("foo").Bar<Z>} Baztype declarations which forward type parameters to the importedsymbol as re-exports of that symbol, #2044.
Bug Fixes
widgets.pngand[email protected]files from generated assets folder.v0.23.14 (2022-09-03)
Features
externalSymbolLinkMappingsseethe documentation for usage examples and caveats, #2030.
addUnknownSymbolResolverwill now be checked when resolving@linktags, #2030.Note: To support this, resolution will now happen during conversion, and as such,
Renderer.addUnknownSymbolResolverhas beensoft deprecated in favor of
Converter.addUnknownSymbolResolver. Plugins should update to use the method onConverter.DefaultThemeRenderContext.attemptExternalResolutionhas also been deprecated since it will repeat work done during conversion,use
ReferenceType.externalUrlinstead.Converter.addUnknownSymbolResolverfor use by plugins supporting external links.Bug Fixes
v0.23.13 (2022-09-01)
Bug Fixes
v0.23.12 (2022-08-31)
Features
ParameterType.Objectfor declaring object options which will be shallowly merged when read from user configuration.Application.EVENT_BOOTSTRAP_ENDevent emitted whenApplication.bootstrapis called.Bug Fixes
isIdentifierOrPrivateIdentifier.Thanks!
v0.23.11 (2022-08-26)
Features
skipErrorCheckingoption which instructs TypeDoc to not ask TypeScript for compiler errorsbefore attempting to generate documentation. Turning this on may improve generation speed, but could also
cause a crash if your code contains compiler errors.
Bug Fixes
@linktags resolved, #2029.DefaultThemeRenderContextnow contain all the HTML for their sections of the page, #2038.Thanks!
v0.23.10 (2022-07-31)
Features
sortoption.propasprop?, #2023.DefaultThemeRenderContext.markdownnow also accepts aCommentDisplayPart[]for rendering, #2004.Converter.resolveLinksmethod for use withConverter.parseRawComment, #2004.Bug Fixes
typedoc/tsdoc.jsonin TSDoc extends, #2015.@typedefcomments for properties, #2020.Thanks!
v0.23.9 (2022-07-24)
Bug Fixes
If using
"entryPointStrategy": "expand", this change may result in new pages being added to your documentation.If this is not desired, you can use the
excludeoption to filter them out.--includeVersionflag, #2010.v0.23.8 (2022-07-17)
Features
*.ghe.comand*.github.usGitHub enterprise domains for source links, #2001.Converter.parseRawCommentfor plugins to parse additional markdown files, #2004.Bug Fixes
{@​link}containing a URL, #1980.excludeNotDocumentedwill no longer remove functions/methods/accessors which are documented, #1994.sourcesproperty on signature reflections #1996.Thanks!
v0.23.7 (2022-07-09)
Bug Fixes
@jest/globalsin a comment will no longer be parsed as a tag #1990.v0.23.6 (2022-07-08)
Features
--entryPointStrategy Packages. TypeDoc will now load package-specific configurations frompackage.jsontypedocfield. This configuration allows configuring a custom display name (typedoc.displayName) field, entry point (typedoc.entryPoint- this is equivalent and will overridetypedocMain), and path to a readme file to be rendered at the top of the package page (typedoc.readmeFile), #1658.--includeVersionoption will now be respected by--entryPointStrategy Packages. Also, for this combination, missingversionfield in the rootpackage.jsonwill not issue a warning.navigationpartial will now call the newsettings,primaryNavigation, andsecondaryNavigationpartials, #1987.Bug Fixes
Thanks!
v0.23.5 (2022-07-02)
Features
DEBUG_SEARCH_WEIGHTSglobal variable can now be set onwindowto add search scoring information in the search results.DefaultThemeRenderContext.iconsfor use/modification by themes.v0.23.4 (2022-07-02)
Bug Fixes
--entryPointStrategy Packagesis set, #1976.search.jsgenerated file.Features
--excludeoption will now be respected by--entryPointStrategy Packagesand can be used to exclude package directories, #1959.IndexEventon theRendererwhen preparing the search index, #1953.--searchInCommentsoption to include comment text in the search index, #1553.Turning this option on will increase the size of your search index, potentially by an order of magnitude.
v0.23.3 (2022-07-01)
Bug Fixes
@exampletag, #1967.intentionallyNotExportedwill now properly respect qualified names, #1972.export * as NSdeclarations, #1973.export const x = () => 123function variables, #1973.getandsetsignatures of an accessor have a comment.Features
--htmlLangoption to set thelangattribute in the generated HTML. Defaults toen, #1951.--basePathoption to override TypeDoc's detected root directory, #1924.:getterand:settermeaning keywords in declaration references.v0.23.2 (2022-06-28)
Bug Fixes
@modulecomments in the entry point, #1963.<= 0due tosearchCategoryBoostsorsearchGroupBoostswill be excluded from search.v0.23.1 (2022-06-26)
Bug Fixes
v0.23.28Compare Source
Features
consttype parameters.@overloadtag.@satisfiestag.Configuration
📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about this update again.
This PR has been generated by Mend Renovate. View repository job log here.