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
Moved from marked to markdown-it for parsing as marked has moved to an async model which supporting would significantly complicate TypeDoc's rendering code.
This means that any projects setting markedOptions needs to be updated to use markdownItOptions.
Unlike marked@4, markdown-it pushes lots of functionality to plugins. To use plugins, a JavaScript config file must be used with the markdownItLoader option.
Updated Shiki from 0.14 to 1.x. This should mostly be a transparent update which adds another 23 supported languages and 13 supported themes.
As Shiki adds additional languages, the time it takes to load the highlighter increases linearly. To avoid rendering taking longer than necessary,
TypeDoc now only loads a few common languages. Additional languages can be loaded by setting the --highlightLanguages option.
Changed default of --excludePrivate to true.
Renamed --sitemapBaseUrl to --hostedBaseUrl to reflect that it can be used for more than just the sitemap.
Removed deprecated navigation.fullTree option.
Removed --media option, TypeDoc will now detect image links within your comments and markdown documents and automatically copy them to the site.
Removed --includes option, use the @document tag instead.
Removed --stripYamlFrontmatter option, TypeDoc will always do this now.
Renamed the --htmlLang option to --lang.
Removed the --gaId option for Google Analytics integration and corresponding analytics theme member, #2600.
All function-likes may now have comments directly attached to them. This is a change from previous versions of TypeDoc where functions comments
were always moved down to the signature level. This mostly worked, but caused problems with type aliases, so was partially changed in 0.25.13.
This change was extended to apply not only to type aliases, but also other function-likes declared with variables and callable properties.
As a part of this change, comments on the implementation signature of overloaded functions will now be added to the function reflection, and will
not be inherited by signatures of that function, #2521.
API: TypeDoc now uses a typed event emitter to provide improved type safety, this found a bug where Converter.EVENT_CREATE_DECLARATION
was emitted for ProjectReflection in some circumstances.
API: MapOptionDeclaration.mapError has been removed.
API: Deprecated BindOption decorator has been removed.
API: DeclarationReflection.indexSignature has been renamed to DeclarationReflection.indexSignatures.
Note: This also affects JSON serialization. TypeDoc will support JSON output from 0.25 through at least 0.26.
API: JSONOutput.SignatureReflection.typeParameter has been renamed to typeParameters to match the JS API.
API: DefaultThemeRenderContext.iconsCache has been removed as it is no longer needed.
API: DefaultThemeRenderContext.hook must now be passed context if required by the hook.
Features
Added support for TypeScript 5.5.
Added new --projectDocuments option to specify additional Markdown documents to be included in the generated site #247, #1870, #2288, #2565.
TypeDoc now has the architecture in place to support localization. No languages besides English
are currently shipped in the package, but it is now possible to add support for additional languages, #2475.
Added support for a packageOptions object which specifies options that should be applied to each entry point when running with --entryPointStrategy packages, #2523.
--hostedBaseUrl will now be used to generate a <link rel="canonical"> element in the project root page, #2550.
Added support for documenting individual elements of a union type, #2585.
Note: This feature is only available on type aliases directly containing unions.
TypeDoc will now log the number of errors/warnings errors encountered, if any, after a run, #2581.
New option, --customFooterHtml to add custom HTML to the generated page footer, #2559.
TypeDoc will now copy modifier tags to children if specified in the --cascadedModifierTags option, #2056.
TypeDoc will now warn if mutually exclusive modifier tags are specified for a comment (e.g. both @alpha and @beta), #2056.
Groups and categories can now be collapsed in the page body, #2330.
Added support for JSDoc @hideconstructor tag.
This tag should only be used to work around TypeScript#58653, prefer the more general @hidden/@ignore tag to hide members normally, #2577.
Added --useHostedBaseUrlForAbsoluteLinks option to use the --hostedBaseUrl option to produce absolute links to pages on a site, #940.
Tag headers now generate permalinks in the default theme, #2308.
TypeDoc now attempts to use the "most likely name" for a symbol if the symbol is not present in the documentation, #2574.
Fixed an issue where the "On This Page" section would include markdown if the page contained headings which contained markdown.
TypeDoc will now warn if a block tag is used which is not defined by the --blockTags option.
Added three new sort strategies documents-first, documents-last, and alphabetical-ignoring-documents to order markdown documents.
Added new --alwaysCreateEntryPointModule option. When set, TypeDoc will always create a Module for entry points, even if only one is provided.
If --projectDocuments is used to add documents, this option defaults to true, otherwise, defaults to false.
Added new --highlightLanguages option to control what Shiki language packages are loaded.
TypeDoc will now render union elements on new lines if there are more than 3 items in the union.
TypeDoc will now only render the "Type Declaration" section if it will provide additional information not already presented in the page.
This results in significantly smaller documentation pages in many cases where that section would just repeat what has already been presented in the rendered type.
Added comment.beforeTags and comment.afterTags hooks for plugin use.
Combined with CommentTag.skipRendering this can be used to provide custom tag handling at render time.
Bug Fixes
TypeDoc now supports objects with multiple index signatures, #2470.
Header anchor links in rendered markdown are now more consistent with headers generated by TypeDoc, #2546.
Types rendered in the Returns header are now properly colored, #2546.
Links added with the navigationLinks option are now moved into the pull out navigation on mobile displays, #2548.
@license and @import comments will be ignored at the top of files, #2552.
Fixed issue in documentation validation where constructor signatures where improperly considered not documented, #2553.
Keyboard focus is now visible on dropdowns and checkboxes in the default theme, #2556.
The color theme label in the default theme now has an accessible name, #2557.
Fixed issue where search results could not be navigated while Windows Narrator was on, #2563.
charset is now correctly cased in <meta> tag generated by the default theme, #2568.
Fixed very slow conversion on Windows where Msys git was used by typedoc to discover repository links, #2586.
Added gitRevision:short placeholder option to --sourceLinkTemplate option, #2529.
Links generated by TypeDoc will now default to using the non-short git revision.
Moved "Generated by TypeDoc" footer into a <footer> tag, added footer.begin and footer.end
render hooks for use by custom plugins, #2532.
Bug Fixes
Fixed conversion of NoInfer missing type parameter reference, #2539.
Linking to a member on a page no longer incorrectly claims that
"This member is normally hidden due to your filter settings" for every member.
Constructed references to enum types will be properly linked with @interface, #2508.
Comments on property-methods will no longer be duplicated in generated documentation, #2509.
Reduced rendered docs size by writing icons to a referenced SVG asset, #2505.
For TypeDoc's docs, this reduced the rendered documentation size by ~30%.
The HTML docs now attempt to reduce repaints caused by dynamically loading the navigation, #2491.
When navigating to a link that contains an anchor, the page will now be properly highlighted in the page navigation.
TypeDoc will now render interfaces as code at the top of the page describing interfaces, #2449.
This can be controlled through the new DefaultThemeRenderContext.reflectionPreview helper.
Improved type rendering to highlight keywords differently than symbols.
Bug Fixes
Fixed automatic declaration file resolution on Windows, #2416.
Fixed default option values on options declared by plugins in packages mode, #2433.
gitRevision will now be replaced in sourceLinkTemplate, #2434.
Improved handling of function-modules created with Object.assign, #2436.
TypeDoc will no longer warn about duplicate comments with warnings which point to a single comment, #2437
Fixed an infinite loop when skipLibCheck is used to ignore some compiler errors, #2438.
@example tag titles will now be rendered in the example heading, #2440.
Correctly handle transient symbols in @namespace-created namespaces, #2444.
TypeDoc no longer displays the "Hierarchy" section if there is no inheritance hierarchy to display.
Direct links to individual signatures no longer results in the signature being partially scrolled off the screen.
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 override DefaultTheme.buildNavigation
to customize the displayed navigation tree, #2287.
Note: This change renders navigation.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 on DefaultThemeRenderContext.iconCache being rendered within
each page. TypeDoc does it in the defaultLayout template.
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.
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.
TypeDoc will now allow conversion without any entry points to support "readme only" packages, #2264.
Bug Fixes
Category children are now sorted according to the sort option, #2272.
Inline tags no longer require a space after the tag name to be parsed as a tag, #2273.
Fixed module/namespace links in navigation when viewed in Safari, #2275.
v0.24.6 (2023-04-24)
Features
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.
Increased contrast for parameter titles in dark mode to meet WCAG AA contrast requirements, #2244.
Underline color of index links now matches the text color, #2245.
Increased contract for active menu item text in dark mode.
v0.24.3 (2023-04-16)
Bug Fixes
Fixed path expansion on Windows preventing generation, #2243 and #2241.
v0.24.2 (2023-04-15)
Features
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".
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.
Because you closed this PR without merging, Renovate will ignore this update (^0.26.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.
This pull request has been locked because we are very unlikely to see comments on closed issues. If you think, this PR is still necessary, create a new one with the same branch. Thank you.
Sign up for freeto subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Labels
None yet
2 participants
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.
This PR contains the following updates:
^0.24.7
->^0.26.0
Release Notes
TypeStrong/TypeDoc (typedoc)
v0.26.0
Compare Source
Breaking Changes
marked
tomarkdown-it
for parsing as marked has moved to an async model which supporting would significantly complicate TypeDoc's rendering code.This means that any projects setting
markedOptions
needs to be updated to usemarkdownItOptions
.Unlike
marked@4
,markdown-it
pushes lots of functionality to plugins. To use plugins, a JavaScript config file must be used with themarkdownItLoader
option.As Shiki adds additional languages, the time it takes to load the highlighter increases linearly. To avoid rendering taking longer than necessary,
TypeDoc now only loads a few common languages. Additional languages can be loaded by setting the
--highlightLanguages
option.--excludePrivate
totrue
.--sitemapBaseUrl
to--hostedBaseUrl
to reflect that it can be used for more than just the sitemap.navigation.fullTree
option.--media
option, TypeDoc will now detect image links within your comments and markdown documents and automatically copy them to the site.--includes
option, use the@document
tag instead.--stripYamlFrontmatter
option, TypeDoc will always do this now.--htmlLang
option to--lang
.--gaId
option for Google Analytics integration and correspondinganalytics
theme member, #2600.were always moved down to the signature level. This mostly worked, but caused problems with type aliases, so was partially changed in 0.25.13.
This change was extended to apply not only to type aliases, but also other function-likes declared with variables and callable properties.
As a part of this change, comments on the implementation signature of overloaded functions will now be added to the function reflection, and will
not be inherited by signatures of that function, #2521.
Converter.EVENT_CREATE_DECLARATION
was emitted for
ProjectReflection
in some circumstances.MapOptionDeclaration.mapError
has been removed.BindOption
decorator has been removed.DeclarationReflection.indexSignature
has been renamed toDeclarationReflection.indexSignatures
.Note: This also affects JSON serialization. TypeDoc will support JSON output from 0.25 through at least 0.26.
JSONOutput.SignatureReflection.typeParameter
has been renamed totypeParameters
to match the JS API.DefaultThemeRenderContext.iconsCache
has been removed as it is no longer needed.DefaultThemeRenderContext.hook
must now be passedcontext
if required by the hook.Features
--projectDocuments
option to specify additional Markdown documents to be included in the generated site #247, #1870, #2288, #2565.are currently shipped in the package, but it is now possible to add support for additional languages, #2475.
packageOptions
object which specifies options that should be applied to each entry point when running with--entryPointStrategy packages
, #2523.--hostedBaseUrl
will now be used to generate a<link rel="canonical">
element in the project root page, #2550.Note: This feature is only available on type aliases directly containing unions.
--customFooterHtml
to add custom HTML to the generated page footer, #2559.--cascadedModifierTags
option, #2056.@alpha
and@beta
), #2056.@hideconstructor
tag.This tag should only be used to work around TypeScript#58653, prefer the more general
@hidden
/@ignore
tag to hide members normally, #2577.--useHostedBaseUrlForAbsoluteLinks
option to use the--hostedBaseUrl
option to produce absolute links to pages on a site, #940.--blockTags
option.documents-first
,documents-last
, andalphabetical-ignoring-documents
to order markdown documents.--alwaysCreateEntryPointModule
option. When set, TypeDoc will always create aModule
for entry points, even if only one is provided.If
--projectDocuments
is used to add documents, this option defaults totrue
, otherwise, defaults tofalse
.--highlightLanguages
option to control what Shiki language packages are loaded.This results in significantly smaller documentation pages in many cases where that section would just repeat what has already been presented in the rendered type.
comment.beforeTags
andcomment.afterTags
hooks for plugin use.Combined with
CommentTag.skipRendering
this can be used to provide custom tag handling at render time.Bug Fixes
Returns
header are now properly colored, #2546.navigationLinks
option are now moved into the pull out navigation on mobile displays, #2548.@license
and@import
comments will be ignored at the top of files, #2552.charset
is now correctly cased in<meta>
tag generated by the default theme, #2568.<head>
element could result in broken icons, #2589.@default
and@defaultValue
blocks are now recognized as regular blocks if they include inline tags, #2601.localStorage
.--hideParameterTypesInTitle
option no longer applies when rendering function types.@link
tags in readme files will now cause a warning when link validation is enabled.externalSymbolLinkMappings
option's support for meanings in declaration references.type=button
attribute set to avoid being treated as submit buttons.--hostedBaseUrl
will now implicitly add a trailing slash to the generated URL.Thanks!
v0.25.13
Compare Source
Features
gitRevision:short
placeholder option to--sourceLinkTemplate
option, #2529.Links generated by TypeDoc will now default to using the non-short git revision.
<footer>
tag, addedfooter.begin
andfooter.end
render hooks for use by custom plugins, #2532.
Bug Fixes
NoInfer
missing type parameter reference, #2539."This member is normally hidden due to your filter settings" for every member.
Thanks!
v0.25.12
Compare Source
Bug Fixes
Thanks!
v0.25.11
Compare Source
Bug Fixes
h1>h2>h3
process, #2515.v0.25.10
Compare Source
Bug Fixes
@interface
, #2508.For TypeDoc's docs, this reduced the rendered documentation size by ~30%.
v0.25.9
Compare Source
Features
Bug Fixes
--excludeNotDocumented
was used and the project contained a reference to a removed signature, #2496.--maxTypeConversionDepth
option, #2507.Thanks!
v0.25.8
Compare Source
v0.25.7
Compare Source
Bug Fixes
v0.25.6
Compare Source
Bug Fixes
v0.25.5
Compare Source
v0.25.4
Compare Source
Features
This can be controlled through the new
DefaultThemeRenderContext.reflectionPreview
helper.Bug Fixes
gitRevision
will now be replaced insourceLinkTemplate
, #2434.Object.assign
, #2436.skipLibCheck
is used to ignore some compiler errors, #2438.@example
tag titles will now be rendered in the example heading, #2440.@namespace
-created namespaces, #2444.Thanks!
v0.25.3
Compare Source
Features
--sourceLinkExternal
option to render source code links as external, #2415.declarationMap
option to be set to true to handle cross-package links in packages mode, #2416.external-last
option for the--sort
option, #2418.Bug Fixes
Thanks!
v0.25.2
Compare Source
Features
navigationLeaves
option to remove branches from the navigation tree, #2382.sortEntryPoints
option (defaults to true) to allow disabling entry point sorting, #2393.Bug Fixes
@template
constraints on JSDoc defined type parameters, #2389.declare module "foo"
, #2401.Thanks!
v0.25.1
Compare Source
Features
stripYamlFrontmatter
config option to remove YAML frontmatter from README.md, #2381.--excludeCategories
config option to remove reflections present in any excluded category, #1407.with large projects and also provides large space benefits. Themes may now override
DefaultTheme.buildNavigation
to customize the displayed navigation tree, #2287.
Note: This change renders
navigation.fullTree
obsolete. If you set it, TypeDoc will warn that it is being ignored.It will be removed in v0.26.
DefaultThemeRenderContext.icons
is overwritten by a custom theme.Note: To perform this optimization, TypeDoc relies on
DefaultThemeRenderContext.iconCache
being rendered withineach page. TypeDoc does it in the
defaultLayout
template.Bug Fixes
@property
now works as expected if used to override a method's documentation.--watch
mode works again, #2378.intrinsic
keyword if TS intrinsic types are included in documentation.--exclude
is now respected when expanding globs in entry points, #2376.Thanks!
v0.25.0
Compare Source
Breaking Changes
legacy-packages
option for--entryPointStrategy
.--categorizeByGroup
tofalse
.gitRemote
is no longer supported.Application
instance must now be retrieved viaApplication.bootstrap
orApplication.bootstrapWithPlugins
, #2268.ReflectionKind.ObjectLiteral
that was never used by TypeDoc.DefaultThemeRenderContext.comment
andDefaultThemeRenderContext.attemptExternalResolution
.Features
--preserveLinkText
option (defaults to true) which determines whether the reflection name or full link text is includedin the output when no override is specified, #2355.
site from ~5.6 seconds to ~5.4 seconds.
--disableGit
option to prevent TypeDoc from using Git to try to determine if sources can be linked, #2326.@showGroups
,@hideGroups
,@showCategories
,@hideCategories
to configure the navigation pane on aper-reflection basis, #2329.
--jsDocCompatibility.defaultTags
set,@defaultValue
is now implicitly a code block if the text contains no code, #2370.Bug Fixes
Foo#bar
) links were used and--useTsLinkResolution
is enabled in some cases, #2360.@inheritDoc
was not properly resolved across packages in packages mode, #2331.@interface
use on union types, #2352.Theme.getUrls
, #2318.@namespace
is used on a variable with an associated namespace, #2364.@namespace
property discovery if merged with a type and the type was declared first #2364.reflection.sources
now considers the node's name like non-signature location discovery does.Thanks!
v0.24.8 (2023-06-04)
Features
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.
--pretty
option now also controls whether generated HTML contains line breaks, #2287.MarkdownEvent.INCLUDE
for plugins, #2284.Bug Fixes
and any other block tags in the order they are defined in the comment, #2285.
Thanks!
v0.24.7 (2023-05-08)
Features
Bug Fixes
sort
option, #2272.v0.24.6 (2023-04-24)
Features
g
,circle
,ellipse
,polygon
, andpolyline
svg elements, #2259.jsDocCompatibility
option withinheritDocTag
to ignore fully lowercaseinheritDoc
tags andignoreUnescapedBraces
to disable warnings about unescaped{
and}
characters in comments.Bug Fixes
--useTsLinkResolution
is no longer ignored within block tags, #2260.Thanks!
v0.24.5 (2023-04-22)
Features
--navigation.includeCategories
and
--navigation.includeGroups
to control this behavior. The--categorizeByGroup
option alsoeffects this behavior. If
categorizeByGroup
is set (the default) andnavigation.includeGroups
isnot set, the value of
navigation.includeCategories
will be effectively ignored since categorieswill be created only within groups, #1532.
@returns
blocks will now be rendered with the return type, #2180.--groupOrder
option to specify the sort order of groups, #2251.Bug Fixes
--hideParameterTypesInTitle
option, #2226.@returns
block is is present in a function, and ignore the duplicate blocks as specified by TSDoc.Thanks!
v0.24.4 (2023-04-16)
Bug Fixes
v0.24.3 (2023-04-16)
Bug Fixes
v0.24.2 (2023-04-15)
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
--hideParameterTypesInTitle
option.Bug Fixes
&
showing as&
and HTML text showing up in page contents navigation, #2224.source-order
sort strategy failing to compare reflections within a file.enum-member-source-order
specialization of thesource-order
sort strategy which only compares enum members, #2237.__@​
symbol name, #2234.--entryPointStrategy packages
.Thanks!
v0.24.1 (2023-04-09)
Bug Fixes
@example
tags, #2222.v0.24.8
Compare Source
Features
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.
--pretty
option now also controls whether generated HTML contains line breaks, #2287.MarkdownEvent.INCLUDE
for plugins, #2284.Bug Fixes
and any other block tags in the order they are defined in the comment, #2285.
Thanks!
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.