Bump typedoc from 0.25.0 to 0.25.1

[dependabot]

Bumps typedoc from 0.25.0 to 0.25.1.

Release notes

Sourced from typedoc's releases.

v0.25.1

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

Changelog

Sourced from typedoc's changelog.

v0.25.1 (2023-09-04)

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

Commits

• 5e4c79d Update changelog for release
• 265bf49 Bump version to 0.25.1
• 0985616 Handle projects without tsconfig files
• bcf3e04 Add excludeCategories option
• 653b281 Respect --exclude when expanding globs in entry points
• a6823cf Cache URL derivation during generation
• 1f88a1f Compress search index too
• d68ca2a Update changelog
• dc4a16d feat: stripYamlFrontmatter option (#2387)
• 67ee6ac Dynamically load navigation
• Additional commits viewable in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

---

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

• @dependabot rebase will rebase this PR
• @dependabot recreate will recreate this PR, overwriting any edits that have been made to it
• @dependabot merge will merge this PR after your CI passes on it
• @dependabot squash and merge will squash and merge this PR after your CI passes on it
• @dependabot cancel merge will cancel a previously requested merge and block automerging
• @dependabot reopen will reopen this PR if it is closed
• @dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
• @dependabot show <dependency name> ignore conditions will show all of the ignore conditions of the specified dependency
• @dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
• @dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
• @dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)