TypeStrong/TypeDoc (typedoc)
### [`v0.25.1`](https://togithub.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v0251-2023-09-04)
[Compare Source](https://togithub.com/TypeStrong/TypeDoc/compare/v0.25.0...v0.25.1)
##### Features
- Added `stripYamlFrontmatter` config option to remove YAML frontmatter from README.md, [#2381](https://togithub.com/TypeStrong/TypeDoc/issues/2381).
- Added `--excludeCategories` config option to remove reflections present in any excluded category, [#1407](https://togithub.com/TypeStrong/TypeDoc/issues/1407).
- If no tsconfig.json file is present, TypeDoc will now attempt to compile without setting any compiler options, [#2304](https://togithub.com/TypeStrong/TypeDoc/issues/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](https://togithub.com/TypeStrong/TypeDoc/issues/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](https://togithub.com/TypeStrong/TypeDoc/issues/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](https://togithub.com/TypeStrong/TypeDoc/issues/2378).
- Improved support for optional names within JSDoc types, [#2384](https://togithub.com/TypeStrong/TypeDoc/issues/2384).
- Fixed duplicate rendering of reflection flags on signature parameters, [#2385](https://togithub.com/TypeStrong/TypeDoc/issues/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](https://togithub.com/TypeStrong/TypeDoc/issues/2376).
##### Thanks!
- [@ajesshope](https://togithub.com/ajesshope)
- [@HemalPatil](https://togithub.com/HemalPatil)
- [@hrueger](https://togithub.com/hrueger)
- [@typhonrt](https://togithub.com/typhonrt)
Configuration
📅 Schedule: Branch creation - "before 3am on Monday" (UTC), 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.25.0->0.25.1Release Notes
TypeStrong/TypeDoc (typedoc)
### [`v0.25.1`](https://togithub.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v0251-2023-09-04) [Compare Source](https://togithub.com/TypeStrong/TypeDoc/compare/v0.25.0...v0.25.1) ##### Features - Added `stripYamlFrontmatter` config option to remove YAML frontmatter from README.md, [#2381](https://togithub.com/TypeStrong/TypeDoc/issues/2381). - Added `--excludeCategories` config option to remove reflections present in any excluded category, [#1407](https://togithub.com/TypeStrong/TypeDoc/issues/1407). - If no tsconfig.json file is present, TypeDoc will now attempt to compile without setting any compiler options, [#2304](https://togithub.com/TypeStrong/TypeDoc/issues/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](https://togithub.com/TypeStrong/TypeDoc/issues/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](https://togithub.com/TypeStrong/TypeDoc/issues/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](https://togithub.com/TypeStrong/TypeDoc/issues/2378). - Improved support for optional names within JSDoc types, [#2384](https://togithub.com/TypeStrong/TypeDoc/issues/2384). - Fixed duplicate rendering of reflection flags on signature parameters, [#2385](https://togithub.com/TypeStrong/TypeDoc/issues/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](https://togithub.com/TypeStrong/TypeDoc/issues/2376). ##### Thanks! - [@ajesshope](https://togithub.com/ajesshope) - [@HemalPatil](https://togithub.com/HemalPatil) - [@hrueger](https://togithub.com/hrueger) - [@typhonrt](https://togithub.com/typhonrt)Configuration
📅 Schedule: Branch creation - "before 3am on Monday" (UTC), 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.