chore(deps): update dependency typedoc to v0.27.5

[renovate]

This PR contains the following updates:

Package	Change	Age	Adoption	Passing	Confidence
typedoc (source)	0.15.5 -> 0.27.5

---

Release Notes

TypeStrong/TypeDoc (typedoc)

v0.27.5

Compare Source

Bug Fixes

• Possibly Breaking: TypeDoc will no longer render anchors within the page for
  deeply nested properties. This only affects links to properties of
  properties of types, which did not have a clickable link exposed so are
  unlikely to have been linked to. Furthermore, these links were not always
  created by TypeDoc, only being created if all parent properties contained
  comments, #​2808.
• TypeDoc will now warn if a property which does not have a URL within the
  rendered document and the parent property/page will be linked to instead,
  #​2808. These warnings can be disabled with the validation.rewrittenLink
  option.
• Fix restoration of groups/categories including documents, #​2801.
• Fixed missed relative paths within markdown link references in documents.
• Improved handling of incomplete inline code blocks within markdown.
• Direct https:// links under the hostedBaseUrl option's URL will no
  longer be treated as external, #​2809.

Thanks!

• @​SacDeNoeuds

v0.27.4

Compare Source

Features

• API: Introduced new Converter.EVENT_CREATE_PROJECT event which fires when a project is created by the converter, #​2800.

Bug Fixes

• Switch from gzip to deflate for compressing assets to make output consistent across different operating systems, #​2796.
• @include and @includeCode now work for comments on the entry point for projects with a single entry point, #​2800.
• Cascaded modifier tags will no longer be copied into type literals, #​2802.
• @summary now works to describe functions within modules, #​2803.
• Corrected navigation showing module link as current when not on module page, #​2805.

v0.27.3

Compare Source

Features

• Added support for PNG favicons, #​2790.
• Improved support for hosting TypeDoc with strict Content Security Policy rules, #​2794.

Bug Fixes

• Add special handling for import types with type errors discarded with ts-expect-error, #​2792.
• Fixed low contrast in default colors for properties/accessors in light mode, #​2795.
• The highlightLanguages option now permits Shiki aliases to be specified rather than just the language ID, #​2798.

Thanks!

• @​mikalai-snap
• @​mistic100

v0.27.2

Compare Source

Bug Fixes

• Fix crash with TypeScript 5.5.x, #​2789.

v0.27.1

Compare Source

Bug Fixes

• Include classes which inherit from another package in class hierarchy in packages mode, #​2467.
• Fixed handling of @categoryDescription and @groupDescription on module pages, #​2787.
• Fixed automatic discovery of entry points in packages mode.
• Reverted accidental style change for hierarchy page introduced in 0.27.0
• The hierarchy Expand/Collapse link will now only appear if the hierarchies are different.

v0.27.0

Compare Source

Breaking Changes

• Convert to ESM to enable easier use of ESM-only dependencies.
• Drop support for TypeScript <5.0, no longer supported by DefinitelyTyped
• Relaxed requirements for file names and generated url fragments. This may
  result in a different file name structure, #​2714.
• Anchors to document headings and reflections within a HTML generated pages
  have changed. They can be partially restored to the previous format by
  setting --sluggerConfiguration.lowercase false. This change was made to
  more closely match the default behavior of GitHub's markdown rendering and
  VSCode's autocomplete when creating a relative link to an external markdown
  file.
• Removed the hideParameterTypesInTitle option, this was originally added as
  a workaround for many signatures overflowing the available horizontal space
  in rendered pages. TypeDoc now has logic to wrap types/signatures smartly,
  so this option is no longer necessary.
• Changed the default kindSortOrder to put references last.
• Changed the default sort order to use alphabetical-ignoring-documents
  instead of alphabetical.
• Changed default of suppressCommentWarningsInDeclarationFiles to true
• API: Constructor signatures now use the parent class name as their name
  (e.g. X, not new X)
• API: @group, @category, @groupDescription and @categoryDescription
  will no longer be removed from the reflections they are present on. They are
  skipped during rendering with the notRenderedTags option.

Features

• Add support for TypeScript 5.7
• TypeDoc will now discover entry points from package.json exports if they
  are not provided manually, #​1937.
• Relative links to markdown files may now include #anchor links to
  reference a heading within them.
• Improved support for @param comments with nested object types, #​2555.
• Improved support for @param comments which reference a type
  alias/interface. Important properties on the referenced type can now be
  highlighted with @param options.foo, which will result in the additional
  note being included under the documentation for that parameter, #​2147. Note:
  This feature is limited to references. It is not supported on other types of
  types.
• Added a new outputs option which is an array of outputs. This can be used
  to render the documentation multiple times with different rendering options
  or output types, #​2597.
• Added support for rendering alerts (or callouts) in markdown.
• Add support for an @expand tag which can be placed on type aliases and
  interfaces. When a type with @expand is referenced and TypeDoc has a place
  to include additional details about the type, the properties of the type
  will be included in the page where @expand is found. Note that use of this
  tag can significantly increase the size of your generated documentation if
  it is applied to commonly used types as it will result in inlining the
  comments for those types everywhere they are referenced, #​2303.
• Add support for an @inline tag which can be placed on type aliases and
  interfaces. When a type with @inline is referenced, TypeDoc will resolve
  the referenced type and convert the type as if it was included directly
  within the referencing type. Note that use of this tag can significantly
  increase the size of your generated documentation if it is applied to
  commonly used types as it will result in inlining the comments for those
  types everywhere they are referenced, #​2303.
• Introduced a new @useDeclaredType tag for type aliases which can sometimes
  improve their documentation, #​2654.
• Added a new @mergeModuleWith tag which can be used to tell TypeDoc to
  place a module/namespace's children under a different module/namespace and
  remove the real parent, #​2281.
• Added new @include and @includeCode inline tags to include files within
  comments/documents.
• Add notRenderedTags option. This option is similar to the excludeTags
  option, but while excludeTags will result in the tag being completely
  removed from the documentation, notRenderedTags only prevents it from
  being included when rendering.
• Added groupReferencesByType option.
• Added navigation.excludeReferences option
• Added useFirstParagraphOfCommentAsSummary option to configure how TypeDoc
  handles comments for module members without the @summary tag.
• Introduced favicon option to specify a .ico or .svg favicon to reference.
• Sections within the page and in the "On This Page" navigation are now tied
  together and will expand/collapse together, #​2335.
• API: Introduced a new app.outputs object for defining new output strategies.
• API: TypeDoc's CSS is now wrapped in @layer typedoc, #​2782.

Bug Fixes

• TypeDoc now properly flags readonly index signatures.
• TypeDoc will now use the first signature's comment for later signatures in
  overloads if present, #​2718.
• Fixed handling of @enum if the type was declared before the variable, #​2719.
• Fixed empty top level modules page in packages mode, #​2753.
• TypeDoc can now link to type alias properties, #​2524.
• TypeDoc will now document the merged symbol type when considering globals
  declared inside declare global, #​2774
• TypeDoc now converts declare module "foo" as a module rather than a namespace, #​2778.
• Import types in type aliases now use module member references if present, #​2779.
• Fixed an issue where properties were not properly marked optional in some
  cases. This primarily affected destructured parameters.
• Added yaml to the highlight languages supported by default.
• TypeDoc now recognizes txt as an alias of text to indicate a code block
  should not be highlighted.
• Items which are hidden with @ignore or @hidden but still referenced by
  other types will no longer produce warnings about not being exported.
• If a project only has one module within it, TypeDoc will now consider that
  module when resolving @link tags.
• The arrows to indicate whether or not a section is open now work when
  JavaScript is disabled.
• Group/category search boosts are now applied when writing the search index
  rather than when converting. This prevents issues where boosts used by just
  one package were incorrectly reported as unused when running with
  entryPointStrategy set to packages.

Thanks!

• @​Huxpro
• @​mrfigg
• @​tgreyuk
• @​XeroAlpha

v0.26.11

Compare Source

Features

• If hostedBaseUrl is set to the root page on a website, TypeDoc will now include WebSite structured data, #​2760.

Bug Fixes

• Fix support for ESM config files with Node 23, #​2752.
• Fix type errors when using "module": "ESNext" and importing TypeDoc, #​2747.
• Inherited comments on overloaded methods now consider the overload position when inheriting a comment, #​2755.

v0.26.10

Compare Source

Bug Fixes

• Fixed missing space on page headers, #​2748.

v0.26.9

Compare Source

Features

• Added headings option to control optional headings, #​2729.
• Updated Chinese translations, #​2739.
• Added a folder icon to page navigation elements which are not links, #​2741.

Bug Fixes

• externalSymbolLinkMappings now uses the TypeScript reported link target if available, #​2725.
• TypeDoc will no longer omit the modules page if a project contains only modules/documents, #​2730.
• Fixed missing breadcrumbs on project page, #​2728.
• TypeDoc will no longer render an empty readme page if no readme was found.

Thanks!

• @​lriggle-strib
• @​mrfigg
• @​XeroAlpha

v0.26.8

Compare Source

Features

• Updated Chinese translations, #​2706.
• Exported constants no longer render the type and default value if they are the same, #​2717.
• The HTML output now wraps tag blocks with <div> tags and includes the tag name in a class name, #​2723.

Bug Fixes

• Correctly handle external link resolver link text when referencing an external symbol, #​2700.
• Big integer literals are now supported as default values, #​2721.
• Corrected handling of @link tags present in comments at the start of source files.
• The index will now display when a module only contains documents, #​2722.
• ReflectionSymbolId.pos no longer references the position before any doc comments for a symbol.
  This could cause typedoc-plugin-dt-links to produce links which didn't go to the expected location in a file.

Thanks!

• @​Corso02
• @​lriggle-strib
• @​XeroAlpha

v0.26.7

Compare Source

Features

• Support TypeScript 5.6, #​2699.
• Added customJs option to include a script tag in generated HTML output, #​2650.
• Added markdownLinkExternal option to treat http[s]:// links in markdown documents and comments as external to be opened in a new tab, #​2679.
• Added navigation.excludeReferences option to prevent re-exports from appearing in the left hand navigation, #​2685.
• Added support for the @abstract tag, #​2692.

Bug Fixes

• Fixed an issue where links in packages mode would be resolved incorrectly, #​2680.
• @link tags to symbols which are not included in the documentation will produce invalid link warnings again, #​2681.
• Fixed handling of @param tags on comments attached to function callback parameters, #​2683.
• The alphabetical and alphabetical-ignoring-documents sort options now use localeCompare to sort, #​2684.
• Fixed incorrect placement of parameter default values in some signatures with a this parameter, #​2698.

Thanks!

• @​Aryakoste
• @​waynemwashuma

v0.26.6

Compare Source

Features

• Use of the @extends block tag no longer produces warnings, #​2659.
  This tag should only be used in JavaScript projects to specify the type parameters used when extending a parent class. It will not be rendered.
• Added new navigation.compactFolders option to prevent TypeDoc from compacting folders, similar to the VSCode option. #​2667.

Bug Fixes

• The suppressCommentWarningsInDeclarationFiles option now correctly ignores warnings in .d.cts and .d.mts files, #​2647.
• Restored re-exports in the page navigation menu, #​2671.
• JSON serialized projects will no longer contain reflection IDs for other projects created in the same run. Gerrit0/typedoc-plugin-zod#6.
• In packages mode the reflection ID counter will no longer be reset when converting projects. This previously could result in links to files not working as expected.

v0.26.5

Compare Source

Features

• TypeDoc now exposes array option defaults under OptionDefaults, #​2640.

Bug Fixes

• Constructor parameters which share a name with a property on a parent class will no longer inherit the comment on the parent class, #​2636.
• Packages mode will now attempt to use the comment declared in the comment class for inherited members, #​2622.
• TypeDoc no longer crashes when @document includes an empty file, #​2638.
• API: Event listeners added later with the same priority will be called later, #​2643.

Thanks!

• @​bladerunner2020

v0.26.4

Compare Source

Bug Fixes

• The page navigation sidebar no longer incorrectly includes re-exports if the same member is exported with multiple names #​2625.
• Page navigation now ensures the current page is visible when the page is first loaded, #​2626.
• If a relative linked image is referenced multiple times, TypeDoc will no longer sometimes produce invalid links to the image #​2627.
• @link tags will now be validated in referenced markdown documents, #​2629.
• @link tags are now resolved in project documents, #​2629.
• HTML/JSON output generated by TypeDoc now contains a trailing newline, #​2632.
• TypeDoc now correctly handles markdown documents with CRLF line endings, #​2628.
• @hidden is now properly applied when placed in a function implementation comment, #​2634.
• Comments on re-exports are now rendered.

Thanks!

• @​bukowa
• @​garrett-hopper

v0.26.3

Compare Source

Features

• "On This Page" navigation now includes the page groups in collapsible sections, #​2616.

Bug Fixes

• mailto: links are no longer incorrectly recognized as relative paths, #​2613.
• Added @since to the default list of recognized tags, #​2614.
• Relative paths to directories will no longer cause the directory to be copied into the media directory, #​2617.

v0.26.2

Compare Source

Features

• Added a --suppressCommentWarningsInDeclarationFiles option to disable warnings from
  parsing comments in declaration files, #​2611.
• Improved comment discovery to more closely match TypeScript's discovery when getting comments
  for members of interfaces/classes, #​2084, #​2545.

Bug Fixes

• The text non-highlighted language no longer causes warnings when rendering, #​2610.
• If a comment on a method is inherited from a parent class, and the child class does not
  use an @param tag from the parent, TypeDoc will no longer warn about the @param tag.

v0.26.1

Compare Source

Features

• Improved Korean translation coverage, #​2602.

Bug Fixes

• Added @author to the default list of recognized tags, #​2603.
• Anchor links are no longer incorrectly checked for relative paths, #​2604.
• Fixed an issue where line numbers reported in error messages could be incorrect, #​2605.
• Fixed relative link detection for markdown links containing code in their label, #​2606.
• Fixed an issue with packages mode where TypeDoc would use (much) more memory than required, #​2607.
• TypeDoc will no longer crash when asked to render highlighted code for an unsupported language, #​2609.
• Fixed an issue where relatively-linked files would not be copied to the output directory in packages mode.
• Fixed an issue where modifier tags were not applied to top level modules in packages mode.
• Fixed an issue where excluded tags were not removed from top level modules in packages mode.
• .jsonc configuration files are now properly read as JSONC, rather than being passed to require.

Thanks!

• @​KNU-K

v0.26.0

Compare Source

Breaking Changes

• Drop support for Node 16.
• 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.
• Validation will now be run in watch mode, #​2584.
• Fixed an issue where custom themes which added dependencies in the <head> element could result in broken icons, #​2589.
• @default and @defaultValue blocks are now recognized as regular blocks if they include inline tags, #​2601.
• Navigation folders sharing a name will no longer be saved with a shared key to localStorage.
• The --hideParameterTypesInTitle option no longer applies when rendering function types.
• Broken @link tags in readme files will now cause a warning when link validation is enabled.
• Fixed externalSymbolLinkMappings option's support for meanings in declaration references.
• Buttons to copy code now have the type=button attribute set to avoid being treated as submit buttons.
• --hostedBaseUrl will now implicitly add a trailing slash to the generated URL.

Thanks!

• @​Aryakoste
• @​bladerunner2020
• @​Dinnerbone
• @​HarelM
• @​kraenhansen
• @​Nil2000
• @​steve02081504
• @​tristanzander

v0.25.13

Compare Source

Features

• 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.

Thanks!

• @​xuhdev

v0.25.12

Compare Source

Bug Fixes

• Updated page font to work around issues with Mac rendering, #​2518

Thanks!

• @​docmattman

v0.25.11

Compare Source

Bug Fixes

• Fixed an issue introduced with 0.25.10 which causes the page index to initially render empty, #​2514.
• "On This Page" section is now smarter when handling page headings which do not follow the normal h1>h2>h3 process, #​2515.

v0.25.10

Compare Source

Bug Fixes

• 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.

v0.25.9

Compare Source

Features

• Literal numeric unions will now be sorted during conversion, #​2502.

Bug Fixes

• Module readmes will now be included in JSON output, #​2500.
• Fixed crash when --excludeNotDocumented was used and the project contained a reference to a removed signature, #​2496.
• Fixed crash when converting an infinitely recursive type via a new --maxTypeConversionDepth option, #​2507.
• Type links in "Parameters" and "Type Parameters" sections of the page will now be correctly colored.

Thanks!

• @​JMBeresford

v0.25.8

Compare Source

v0.25.7

Compare Source

Bug Fixes

• Fixed an issue where a namespace would not be created for merged function-namespaces only containing types, #​2476.
• Fixed an infinite loop when converting a union type which directly contained another union type which refers to itself, #​2469.

v0.25.6

Compare Source

Bug Fixes

• Fixed infinite loop caused by a fix for some complicated union/intersection types, #​2468.
• Improved infinite loop detection in type converter to reduce false positives.

v0.25.5

Compare Source

v0.25.4

Compare Source

Features

• Added support for TypeScript 5.3, #​2446.
• 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.

Thanks!

• @​li-jia-nan
• @​Nokel81
• @​ocavue
• @​swarnpallav

v0.25.3

Compare Source

Features

• Added --sourceLinkExternal option to render source code links as external, #​2415.
• TypeDoc no longer requires the declarationMap option to be set to true to handle cross-package links in packages mode, #​2416.
• Added external-last option for the --sort option, #​2418.

Bug Fixes

• TypeDoc now attempts to correct local anchor links in readme files which are broken by its deconfliction logic, #​2413.
• TypeDoc now finds comments on index signatures again, #​2414.
• TypeDoc now does a better job of detecting properties when destructured function arguments are used.
• Quotes will now be properly escaped in HTML attribute values.

Thanks!

• @​mogelbrod
• @​rsanchez

v0.25.2

Compare Source

Features

• Added navigationLeaves option to remove branches from the navigation tree, #​2382.
• Added sortEntryPoints option (defaults to true) to allow disabling entry point sorting, #​2393.
• Improved support for multi-word searches, #​2400.

Bug Fixes

• Fixed conversion of @template constraints on JSDoc defined type parameters, #​2389.
• Invalid link validation is now correctly suppressed before all projects have been converted in packages mode, #​2403.
• Fixed tsconfig handling for projects using a solution-style tsconfig, #​2406.
• Fixed broken settings icons caused by icon caching introduced in 0.25.1, #​2408.
• Corrected module comment handling on declaration files containing a single declare module "foo", #​2401.

Thanks!

• @​schiem

v0.25.1

Compare Source

Features

• 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.
• Cache URL derivation during generation, #​2386.

Bug Fixes

• @property now works as expected if used to override a method's documentation.
• Deprecated functions/methods are now correctly rendered with a struck-out name.
• --watch mode works again, #​2378.
• Improved support for optional names within JSDoc types, #​2384.
• Fixed duplicate rendering of reflection flags on signature parameters, #​2385.
• TypeDoc now handles the intrinsic keyword if TS intrinsic types are included in documentation.
• --exclude is now respected when expanding globs in entry points, #​2376.

Thanks!

• @​ajesshope
• @​HemalPatil
• @​hrueger
• @​typhonrt

v0.25.0

Compare Source

Breaking Changes

• Bump minimum Node version to 16.
• 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, #​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!

• @​camc314
• @​cprussin
• @​roggervalf
• @​Th3S4mur41

v0.24.8 (2023-06-04)

Features

• Added support for TypeScript 5.1, #​2296.
• 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 gen

---

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.

---

• If you want to rebase/retry this PR, check this box

---

This PR was generated by Mend Renovate. View the repository job log.

[codecov-io]

Codecov Report

Merging #75 into master will not change coverage by %.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master      #75   +/-   ##
=======================================
  Coverage   86.82%   86.82%           
=======================================
  Files           3        3           
  Lines         129      129           
  Branches        3        3           
=======================================
  Hits          112      112           
  Misses         17       17           

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 2a990ac...e559a8e. Read the comment docs.