TypeStrong/TypeDoc
### [`v0.24.6`](https://togithub.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v0246-2023-04-24)
[Compare Source](https://togithub.com/TypeStrong/TypeDoc/compare/v0.24.5...v0.24.6)
##### Features
- Improved error messaging if a provided entry point could not be converted into a documented module reflection, [#2242](https://togithub.com/TypeStrong/TypeDoc/issues/2242).
- API: Added support for `g`, `circle`, `ellipse`, `polygon`, and `polyline` svg elements, [#2259](https://togithub.com/TypeStrong/TypeDoc/issues/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](https://togithub.com/TypeStrong/TypeDoc/issues/2260).
- The current namespace will also be expanded in the navigation on page load, [#2260](https://togithub.com/TypeStrong/TypeDoc/issues/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.
##### Thanks!
- [@FlippieCoetser](https://togithub.com/FlippieCoetser)
### [`v0.24.5`](https://togithub.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v0245-2023-04-22)
[Compare Source](https://togithub.com/TypeStrong/TypeDoc/compare/v0.24.4...v0.24.5)
##### Features
- 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](https://togithub.com/TypeStrong/TypeDoc/issues/1532).
- Added support for discovering a "module" comment on global files, [#2165](https://togithub.com/TypeStrong/TypeDoc/issues/2165).
- Added copy code to clipboard button, [#2153](https://togithub.com/TypeStrong/TypeDoc/issues/2153).
- Function `@returns` blocks will now be rendered with the return type, [#2180](https://togithub.com/TypeStrong/TypeDoc/issues/2180).
- Added `--groupOrder` option to specify the sort order of groups, [#2251](https://togithub.com/TypeStrong/TypeDoc/issues/2251).
##### Bug Fixes
- Type parameter constraints now respect the `--hideParameterTypesInTitle` option, [#2226](https://togithub.com/TypeStrong/TypeDoc/issues/2226).
- Even more contrast fixes, [#2248](https://togithub.com/TypeStrong/TypeDoc/issues/2248).
- Fix semantic highlighting for predicate type's parameter references, [#2249](https://togithub.com/TypeStrong/TypeDoc/issues/2249).
- Fixed broken links to heading titles.
- Fixed inconsistent styling between type parameter lists and parameter lists.
- TypeDoc will now warn if more than one `@returns` block is is present in a function, and ignore the duplicate blocks as specified by TSDoc.
##### Thanks!
- [@FlippieCoetser](https://togithub.com/FlippieCoetser)
Configuration
📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).
🚦 Automerge: Enabled.
♻ 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 has been generated by Mend Renovate. View repository job log here.
This PR contains the following updates:
0.24.4->0.24.6Release Notes
TypeStrong/TypeDoc
### [`v0.24.6`](https://togithub.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v0246-2023-04-24) [Compare Source](https://togithub.com/TypeStrong/TypeDoc/compare/v0.24.5...v0.24.6) ##### Features - Improved error messaging if a provided entry point could not be converted into a documented module reflection, [#2242](https://togithub.com/TypeStrong/TypeDoc/issues/2242). - API: Added support for `g`, `circle`, `ellipse`, `polygon`, and `polyline` svg elements, [#2259](https://togithub.com/TypeStrong/TypeDoc/issues/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](https://togithub.com/TypeStrong/TypeDoc/issues/2260). - The current namespace will also be expanded in the navigation on page load, [#2260](https://togithub.com/TypeStrong/TypeDoc/issues/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. ##### Thanks! - [@FlippieCoetser](https://togithub.com/FlippieCoetser) ### [`v0.24.5`](https://togithub.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v0245-2023-04-22) [Compare Source](https://togithub.com/TypeStrong/TypeDoc/compare/v0.24.4...v0.24.5) ##### Features - 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](https://togithub.com/TypeStrong/TypeDoc/issues/1532). - Added support for discovering a "module" comment on global files, [#2165](https://togithub.com/TypeStrong/TypeDoc/issues/2165). - Added copy code to clipboard button, [#2153](https://togithub.com/TypeStrong/TypeDoc/issues/2153). - Function `@returns` blocks will now be rendered with the return type, [#2180](https://togithub.com/TypeStrong/TypeDoc/issues/2180). - Added `--groupOrder` option to specify the sort order of groups, [#2251](https://togithub.com/TypeStrong/TypeDoc/issues/2251). ##### Bug Fixes - Type parameter constraints now respect the `--hideParameterTypesInTitle` option, [#2226](https://togithub.com/TypeStrong/TypeDoc/issues/2226). - Even more contrast fixes, [#2248](https://togithub.com/TypeStrong/TypeDoc/issues/2248). - Fix semantic highlighting for predicate type's parameter references, [#2249](https://togithub.com/TypeStrong/TypeDoc/issues/2249). - Fixed broken links to heading titles. - Fixed inconsistent styling between type parameter lists and parameter lists. - TypeDoc will now warn if more than one `@returns` block is is present in a function, and ignore the duplicate blocks as specified by TSDoc. ##### Thanks! - [@FlippieCoetser](https://togithub.com/FlippieCoetser)Configuration
📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).
🚦 Automerge: Enabled.
♻ 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.