Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(deps): update dependency typedoc to ^0.25.1 #797

Merged
merged 1 commit into from
Sep 19, 2023

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Sep 19, 2023

Mend Renovate

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
typedoc (source) ^0.25.0 -> ^0.25.1 age adoption passing confidence

Release Notes

TypeStrong/TypeDoc (typedoc)

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!

Configuration

📅 Schedule: Branch creation - "before 5am every weekday" in timezone America/New_York, Automerge - "every weekday" in timezone America/New_York.

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

@renovate renovate bot requested review from kongponents-bot and a team as code owners September 19, 2023 04:36
@renovate renovate bot enabled auto-merge (squash) September 19, 2023 04:37
@renovate renovate bot merged commit fcdd51e into main Sep 19, 2023
26 checks passed
@renovate renovate bot deleted the renovate/typedoc-0.25.x branch September 19, 2023 05:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant