TypeStrong/TypeDoc (typedoc)
### [`v0.26.11`](https://redirect.github.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v02611-2024-11-01)
[Compare Source](https://redirect.github.com/TypeStrong/TypeDoc/compare/v0.26.10...v0.26.11)
##### Features
- If `hostedBaseUrl` is set to the root page on a website, TypeDoc will now include `WebSite` structured data, [#2760](https://redirect.github.com/TypeStrong/TypeDoc/issues/2760).
##### Bug Fixes
- Fix support for ESM config files with Node 23, [#2752](https://redirect.github.com/TypeStrong/TypeDoc/issues/2752).
- Fix type errors when using `"module": "ESNext"` and importing TypeDoc, [#2747](https://redirect.github.com/TypeStrong/TypeDoc/issues/2747).
- Inherited comments on overloaded methods now consider the overload position when inheriting a comment, [#2755](https://redirect.github.com/TypeStrong/TypeDoc/issues/2755).
### [`v0.26.10`](https://redirect.github.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v02610-2024-10-16)
[Compare Source](https://redirect.github.com/TypeStrong/TypeDoc/compare/v0.26.9...v0.26.10)
##### Bug Fixes
- Fixed missing space on page headers, [#2748](https://redirect.github.com/TypeStrong/TypeDoc/issues/2748).
### [`v0.26.9`](https://redirect.github.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v0269-2024-10-11)
[Compare Source](https://redirect.github.com/TypeStrong/TypeDoc/compare/v0.26.8...v0.26.9)
##### Features
- Added `headings` option to control optional headings, [#2729](https://redirect.github.com/TypeStrong/TypeDoc/issues/2729).
- Updated Chinese translations, [#2739](https://redirect.github.com/TypeStrong/TypeDoc/issues/2739).
- Added a folder icon to page navigation elements which are not links, [#2741](https://redirect.github.com/TypeStrong/TypeDoc/issues/2741).
##### Bug Fixes
- `externalSymbolLinkMappings` now uses the TypeScript reported link target if available, [#2725](https://redirect.github.com/TypeStrong/TypeDoc/issues/2725).
- TypeDoc will no longer omit the modules page if a project contains only modules/documents, [#2730](https://redirect.github.com/TypeStrong/TypeDoc/issues/2730).
- Fixed missing breadcrumbs on project page, [#2728](https://redirect.github.com/TypeStrong/TypeDoc/issues/2728).
- TypeDoc will no longer render an empty readme page if no readme was found.
##### Thanks!
- [@lriggle-strib](https://redirect.github.com/lriggle-strib)
- [@mrfigg](https://redirect.github.com/mrfigg)
- [@XeroAlpha](https://redirect.github.com/XeroAlpha)
### [`v0.26.8`](https://redirect.github.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v0268-2024-10-04)
[Compare Source](https://redirect.github.com/TypeStrong/TypeDoc/compare/v0.26.7...v0.26.8)
##### Features
- Updated Chinese translations, [#2706](https://redirect.github.com/TypeStrong/TypeDoc/issues/2706).
- Exported constants no longer render the type and default value if they are the same, [#2717](https://redirect.github.com/TypeStrong/TypeDoc/issues/2717).
- The HTML output now wraps tag blocks with `
` tags and includes the tag name in a class name, [#2723](https://redirect.github.com/TypeStrong/TypeDoc/issues/2723).
##### Bug Fixes
- Correctly handle external link resolver link text when referencing an external symbol, [#2700](https://redirect.github.com/TypeStrong/TypeDoc/issues/2700).
- Big integer literals are now supported as default values, [#2721](https://redirect.github.com/TypeStrong/TypeDoc/issues/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](https://redirect.github.com/TypeStrong/TypeDoc/issues/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](https://redirect.github.com/Corso02)
- [@lriggle-strib](https://redirect.github.com/lriggle-strib)
- [@XeroAlpha](https://redirect.github.com/XeroAlpha)
### [`v0.26.7`](https://redirect.github.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v0267-2024-09-09)
[Compare Source](https://redirect.github.com/TypeStrong/TypeDoc/compare/v0.26.6...v0.26.7)
##### Features
- Support TypeScript 5.6, [#2699](https://redirect.github.com/TypeStrong/TypeDoc/issues/2699).
- Added `customJs` option to include a script tag in generated HTML output, [#2650](https://redirect.github.com/TypeStrong/TypeDoc/issues/2650).
- Added `markdownLinkExternal` option to treat `http[s]://` links in markdown documents and comments as external to be opened in a new tab, [#2679](https://redirect.github.com/TypeStrong/TypeDoc/issues/2679).
- Added `navigation.excludeReferences` option to prevent re-exports from appearing in the left hand navigation, [#2685](https://redirect.github.com/TypeStrong/TypeDoc/issues/2685).
- Added support for the `@abstract` tag, [#2692](https://redirect.github.com/TypeStrong/TypeDoc/issues/2692).
##### Bug Fixes
- Fixed an issue where links in packages mode would be resolved incorrectly, [#2680](https://redirect.github.com/TypeStrong/TypeDoc/issues/2680).
- `@link` tags to symbols which are not included in the documentation will produce invalid link warnings again, [#2681](https://redirect.github.com/TypeStrong/TypeDoc/issues/2681).
- Fixed handling of `@param` tags on comments attached to function callback parameters, [#2683](https://redirect.github.com/TypeStrong/TypeDoc/issues/2683).
- The `alphabetical` and `alphabetical-ignoring-documents` sort options now use `localeCompare` to sort, [#2684](https://redirect.github.com/TypeStrong/TypeDoc/issues/2684).
- Fixed incorrect placement of parameter default values in some signatures with a `this` parameter, [#2698](https://redirect.github.com/TypeStrong/TypeDoc/issues/2698).
##### Thanks!
- [@Aryakoste](https://redirect.github.com/Aryakoste)
- [@waynemwashuma](https://redirect.github.com/waynemwashuma)
### [`v0.26.6`](https://redirect.github.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v0266-2024-08-18)
[Compare Source](https://redirect.github.com/TypeStrong/TypeDoc/compare/v0.26.5...v0.26.6)
##### Features
- Use of the `@extends` block tag no longer produces warnings, [#2659](https://redirect.github.com/TypeStrong/TypeDoc/issues/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](https://redirect.github.com/TypeStrong/TypeDoc/issues/2667).
##### Bug Fixes
- The `suppressCommentWarningsInDeclarationFiles` option now correctly ignores warnings in `.d.cts` and `.d.mts` files, [#2647](https://redirect.github.com/TypeStrong/TypeDoc/issues/2647).
- Restored re-exports in the page navigation menu, [#2671](https://redirect.github.com/TypeStrong/TypeDoc/issues/2671).
- JSON serialized projects will no longer contain reflection IDs for other projects created in the same run. [Gerrit0/typedoc-plugin-zod#6](https://redirect.github.com/Gerrit0/typedoc-plugin-zod/issues/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`](https://redirect.github.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v0265-2024-07-21)
[Compare Source](https://redirect.github.com/TypeStrong/TypeDoc/compare/v0.26.4...v0.26.5)
##### Features
- TypeDoc now exposes array option defaults under `OptionDefaults`, [#2640](https://redirect.github.com/TypeStrong/TypeDoc/issues/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](https://redirect.github.com/TypeStrong/TypeDoc/issues/2636).
- Packages mode will now attempt to use the comment declared in the comment class for inherited members, [#2622](https://redirect.github.com/TypeStrong/TypeDoc/issues/2622).
- TypeDoc no longer crashes when `@document` includes an empty file, [#2638](https://redirect.github.com/TypeStrong/TypeDoc/issues/2638).
- API: Event listeners added later with the same priority will be called later, [#2643](https://redirect.github.com/TypeStrong/TypeDoc/issues/2643).
##### Thanks!
- [@bladerunner2020](https://redirect.github.com/bladerunner2020)
### [`v0.26.4`](https://redirect.github.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v0264-2024-07-10)
[Compare Source](https://redirect.github.com/TypeStrong/TypeDoc/compare/v0.26.3...v0.26.4)
##### Bug Fixes
- The page navigation sidebar no longer incorrectly includes re-exports if the same member is exported with multiple names [#2625](https://redirect.github.com/TypeStrong/TypeDoc/issues/2625).
- Page navigation now ensures the current page is visible when the page is first loaded, [#2626](https://redirect.github.com/TypeStrong/TypeDoc/issues/2626).
- If a relative linked image is referenced multiple times, TypeDoc will no longer sometimes produce invalid links to the image [#2627](https://redirect.github.com/TypeStrong/TypeDoc/issues/2627).
- `@link` tags will now be validated in referenced markdown documents, [#2629](https://redirect.github.com/TypeStrong/TypeDoc/issues/2629).
- `@link` tags are now resolved in project documents, [#2629](https://redirect.github.com/TypeStrong/TypeDoc/issues/2629).
- HTML/JSON output generated by TypeDoc now contains a trailing newline, [#2632](https://redirect.github.com/TypeStrong/TypeDoc/issues/2632).
- TypeDoc now correctly handles markdown documents with CRLF line endings, [#2628](https://redirect.github.com/TypeStrong/TypeDoc/issues/2628).
- `@hidden` is now properly applied when placed in a function implementation comment, [#2634](https://redirect.github.com/TypeStrong/TypeDoc/issues/2634).
- Comments on re-exports are now rendered.
##### Thanks!
- [@bukowa](https://redirect.github.com/bukowa)
- [@garrett-hopper](https://redirect.github.com/garrett-hopper)
### [`v0.26.3`](https://redirect.github.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v0263-2024-06-28)
[Compare Source](https://redirect.github.com/TypeStrong/TypeDoc/compare/v0.26.2...v0.26.3)
##### Features
- "On This Page" navigation now includes the page groups in collapsible sections, [#2616](https://redirect.github.com/TypeStrong/TypeDoc/issues/2616).
##### Bug Fixes
- `mailto:` links are no longer incorrectly recognized as relative paths, [#2613](https://redirect.github.com/TypeStrong/TypeDoc/issues/2613).
- Added `@since` to the default list of recognized tags, [#2614](https://redirect.github.com/TypeStrong/TypeDoc/issues/2614).
- Relative paths to directories will no longer cause the directory to be copied into the media directory, [#2617](https://redirect.github.com/TypeStrong/TypeDoc/issues/2617).
### [`v0.26.2`](https://redirect.github.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v0262-2024-06-24)
[Compare Source](https://redirect.github.com/TypeStrong/TypeDoc/compare/v0.26.1...v0.26.2)
##### Features
- Added a `--suppressCommentWarningsInDeclarationFiles` option to disable warnings from
parsing comments in declaration files, [#2611](https://redirect.github.com/TypeStrong/TypeDoc/issues/2611).
- Improved comment discovery to more closely match TypeScript's discovery when getting comments
for members of interfaces/classes, [#2084](https://redirect.github.com/TypeStrong/TypeDoc/issues/2084), [#2545](https://redirect.github.com/TypeStrong/TypeDoc/issues/2545).
##### Bug Fixes
- The `text` non-highlighted language no longer causes warnings when rendering, [#2610](https://redirect.github.com/TypeStrong/TypeDoc/issues/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`](https://redirect.github.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v0261-2024-06-22)
[Compare Source](https://redirect.github.com/TypeStrong/TypeDoc/compare/v0.26.0...v0.26.1)
##### Features
- Improved Korean translation coverage, [#2602](https://redirect.github.com/TypeStrong/TypeDoc/issues/2602).
##### Bug Fixes
- Added `@author` to the default list of recognized tags, [#2603](https://redirect.github.com/TypeStrong/TypeDoc/issues/2603).
- Anchor links are no longer incorrectly checked for relative paths, [#2604](https://redirect.github.com/TypeStrong/TypeDoc/issues/2604).
- Fixed an issue where line numbers reported in error messages could be incorrect, [#2605](https://redirect.github.com/TypeStrong/TypeDoc/issues/2605).
- Fixed relative link detection for markdown links containing code in their label, [#2606](https://redirect.github.com/TypeStrong/TypeDoc/issues/2606).
- Fixed an issue with packages mode where TypeDoc would use (much) more memory than required, [#2607](https://redirect.github.com/TypeStrong/TypeDoc/issues/2607).
- TypeDoc will no longer crash when asked to render highlighted code for an unsupported language, [#2609](https://redirect.github.com/TypeStrong/TypeDoc/issues/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](https://redirect.github.com/KNU-K)
### [`v0.26.0`](https://redirect.github.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v0260-2024-06-22)
[Compare Source](https://redirect.github.com/TypeStrong/TypeDoc/compare/v0.25.13...v0.26.0)
##### 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](https://redirect.github.com/TypeStrong/TypeDoc/issues/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](https://redirect.github.com/TypeStrong/TypeDoc/issues/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](https://redirect.github.com/TypeStrong/TypeDoc/issues/247), [#1870](https://redirect.github.com/TypeStrong/TypeDoc/issues/1870), [#2288](https://redirect.github.com/TypeStrong/TypeDoc/issues/2288), [#2565](https://redirect.github.com/TypeStrong/TypeDoc/issues/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](https://redirect.github.com/TypeStrong/TypeDoc/issues/2475).
- Added support for a `packageOptions` object which specifies options that should be applied to each entry point when running with `--entryPointStrategy packages`, [#2523](https://redirect.github.com/TypeStrong/TypeDoc/issues/2523).
- `--hostedBaseUrl` will now be used to generate a `` element in the project root page, [#2550](https://redirect.github.com/TypeStrong/TypeDoc/issues/2550).
- Added support for documenting individual elements of a union type, [#2585](https://redirect.github.com/TypeStrong/TypeDoc/issues/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](https://redirect.github.com/TypeStrong/TypeDoc/issues/2581).
- New option, `--customFooterHtml` to add custom HTML to the generated page footer, [#2559](https://redirect.github.com/TypeStrong/TypeDoc/issues/2559).
- TypeDoc will now copy modifier tags to children if specified in the `--cascadedModifierTags` option, [#2056](https://redirect.github.com/TypeStrong/TypeDoc/issues/2056).
- TypeDoc will now warn if mutually exclusive modifier tags are specified for a comment (e.g. both `@alpha` and `@beta`), [#2056](https://redirect.github.com/TypeStrong/TypeDoc/issues/2056).
- Groups and categories can now be collapsed in the page body, [#2330](https://redirect.github.com/TypeStrong/TypeDoc/issues/2330).
- Added support for JSDoc `@hideconstructor` tag.
This tag should only be used to work around [TypeScript#58653](https://redirect.github.com/TypeScript/TypeDoc/issues/58653), prefer the more general `@hidden`/`@ignore` tag to hide members normally, [#2577](https://redirect.github.com/TypeStrong/TypeDoc/issues/2577).
- Added `--useHostedBaseUrlForAbsoluteLinks` option to use the `--hostedBaseUrl` option to produce absolute links to pages on a site, [#940](https://redirect.github.com/TypeStrong/TypeDoc/issues/940).
- Tag headers now generate permalinks in the default theme, [#2308](https://redirect.github.com/TypeStrong/TypeDoc/issues/2308).
- TypeDoc now attempts to use the "most likely name" for a symbol if the symbol is not present in the documentation, [#2574](https://redirect.github.com/TypeStrong/TypeDoc/issues/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](https://redirect.github.com/TypeStrong/TypeDoc/issues/2470).
- Header anchor links in rendered markdown are now more consistent with headers generated by TypeDoc, [#2546](https://redirect.github.com/TypeStrong/TypeDoc/issues/2546).
- Types rendered in the `Returns` header are now properly colored, [#2546](https://redirect.github.com/TypeStrong/TypeDoc/issues/2546).
- Links added with the `navigationLinks` option are now moved into the pull out navigation on mobile displays, [#2548](https://redirect.github.com/TypeStrong/TypeDoc/issues/2548).
- `@license` and `@import` comments will be ignored at the top of files, [#2552](https://redirect.github.com/TypeStrong/TypeDoc/issues/2552).
- Fixed issue in documentation validation where constructor signatures where improperly considered not documented, [#2553](https://redirect.github.com/TypeStrong/TypeDoc/issues/2553).
- Keyboard focus is now visible on dropdowns and checkboxes in the default theme, [#2556](https://redirect.github.com/TypeStrong/TypeDoc/issues/2556).
- The color theme label in the default theme now has an accessible name, [#2557](https://redirect.github.com/TypeStrong/TypeDoc/issues/2557).
- Fixed issue where search results could not be navigated while Windows Narrator was on, [#2563](https://redirect.github.com/TypeStrong/TypeDoc/issues/2563).
- `charset` is now correctly cased in `` tag generated by the default theme, [#2568](https://redirect.github.com/TypeStrong/TypeDoc/issues/2568).
- Fixed very slow conversion on Windows where Msys git was used by typedoc to discover repository links, [#2586](https://redirect.github.com/TypeStrong/TypeDoc/issues/2586).
- Validation will now be run in watch mode, [#2584](https://redirect.github.com/TypeStrong/TypeDoc/issues/2584).
- Fixed an issue where custom themes which added dependencies in the `` element could result in broken icons, [#2589](https://redirect.github.com/TypeStrong/TypeDoc/issues/2589).
- `@default` and `@defaultValue` blocks are now recognized as regular blocks if they include inline tags, [#2601](https://redirect.github.com/TypeStrong/TypeDoc/issues/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](https://typedoc.org/guides/declaration-references/#meaning) 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](https://redirect.github.com/Aryakoste)
- [@bladerunner2020](https://redirect.github.com/bladerunner2020)
- [@Dinnerbone](https://redirect.github.com/Dinnerbone)
- [@HarelM](https://redirect.github.com/HarelM)
- [@kraenhansen](https://redirect.github.com/kraenhansen)
- [@Nil2000](https://redirect.github.com/Nil2000)
- [@steve02081504](https://redirect.github.com/steve02081504)
- [@tristanzander](https://redirect.github.com/tristanzander)
### [`v0.25.13`](https://redirect.github.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v02513-2024-04-07)
[Compare Source](https://redirect.github.com/TypeStrong/TypeDoc/compare/v0.25.12...v0.25.13)
##### Features
- Added `gitRevision:short` placeholder option to `--sourceLinkTemplate` option, [#2529](https://redirect.github.com/TypeStrong/TypeDoc/issues/2529).
Links generated by TypeDoc will now default to using the non-short git revision.
- Moved "Generated by TypeDoc" footer into a `
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
This PR contains the following updates:
^0.25.0->^0.26.0Release Notes
TypeStrong/TypeDoc (typedoc)
### [`v0.26.11`](https://redirect.github.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v02611-2024-11-01) [Compare Source](https://redirect.github.com/TypeStrong/TypeDoc/compare/v0.26.10...v0.26.11) ##### Features - If `hostedBaseUrl` is set to the root page on a website, TypeDoc will now include `WebSite` structured data, [#2760](https://redirect.github.com/TypeStrong/TypeDoc/issues/2760). ##### Bug Fixes - Fix support for ESM config files with Node 23, [#2752](https://redirect.github.com/TypeStrong/TypeDoc/issues/2752). - Fix type errors when using `"module": "ESNext"` and importing TypeDoc, [#2747](https://redirect.github.com/TypeStrong/TypeDoc/issues/2747). - Inherited comments on overloaded methods now consider the overload position when inheriting a comment, [#2755](https://redirect.github.com/TypeStrong/TypeDoc/issues/2755). ### [`v0.26.10`](https://redirect.github.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v02610-2024-10-16) [Compare Source](https://redirect.github.com/TypeStrong/TypeDoc/compare/v0.26.9...v0.26.10) ##### Bug Fixes - Fixed missing space on page headers, [#2748](https://redirect.github.com/TypeStrong/TypeDoc/issues/2748). ### [`v0.26.9`](https://redirect.github.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v0269-2024-10-11) [Compare Source](https://redirect.github.com/TypeStrong/TypeDoc/compare/v0.26.8...v0.26.9) ##### Features - Added `headings` option to control optional headings, [#2729](https://redirect.github.com/TypeStrong/TypeDoc/issues/2729). - Updated Chinese translations, [#2739](https://redirect.github.com/TypeStrong/TypeDoc/issues/2739). - Added a folder icon to page navigation elements which are not links, [#2741](https://redirect.github.com/TypeStrong/TypeDoc/issues/2741). ##### Bug Fixes - `externalSymbolLinkMappings` now uses the TypeScript reported link target if available, [#2725](https://redirect.github.com/TypeStrong/TypeDoc/issues/2725). - TypeDoc will no longer omit the modules page if a project contains only modules/documents, [#2730](https://redirect.github.com/TypeStrong/TypeDoc/issues/2730). - Fixed missing breadcrumbs on project page, [#2728](https://redirect.github.com/TypeStrong/TypeDoc/issues/2728). - TypeDoc will no longer render an empty readme page if no readme was found. ##### Thanks! - [@lriggle-strib](https://redirect.github.com/lriggle-strib) - [@mrfigg](https://redirect.github.com/mrfigg) - [@XeroAlpha](https://redirect.github.com/XeroAlpha) ### [`v0.26.8`](https://redirect.github.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v0268-2024-10-04) [Compare Source](https://redirect.github.com/TypeStrong/TypeDoc/compare/v0.26.7...v0.26.8) ##### Features - Updated Chinese translations, [#2706](https://redirect.github.com/TypeStrong/TypeDoc/issues/2706). - Exported constants no longer render the type and default value if they are the same, [#2717](https://redirect.github.com/TypeStrong/TypeDoc/issues/2717). - The HTML output now wraps tag blocks with `⚠️ No Changeset found
Latest commit: 99b829d47cc970d598b5383876f8fdfcf49a3d87
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 typesClick here to learn what changesets are, and how to add one.
Click here if you're a maintainer who wants to add a changeset to this PR
Codecov Report
All modified and coverable lines are covered by tests :white_check_mark:
Additional details and impacted files
```diff @@ Coverage Diff @@ ## main #729 +/- ## ======================================= Coverage 93.93% 93.93% ======================================= Files 34 34 Lines 791 791 Branches 225 225 ======================================= Hits 743 743 Misses 48 48 ``` | [Flag](https://app.codecov.io/gh/JonasKruckenberg/imagetools/pull/729/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Jonas+Kruckenberg) | Coverage Δ | | |---|---|---| | [imagetools-core](https://app.codecov.io/gh/JonasKruckenberg/imagetools/pull/729/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Jonas+Kruckenberg) | `93.93% <ø> (ø)` | | | [vite-imagetools](https://app.codecov.io/gh/JonasKruckenberg/imagetools/pull/729/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Jonas+Kruckenberg) | `93.93% <ø> (ø)` | | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Jonas+Kruckenberg#carryforward-flags-in-the-pull-request-comment) to find out more.:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.