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

fix(deps): update dependency typedoc-plugin-markdown to v4.5.2 #27

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Feb 10, 2025

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
typedoc-plugin-markdown (source) 4.4.1 -> 4.5.2 age adoption passing confidence

Release Notes

typedoc2md/typedoc-plugin-markdown (typedoc-plugin-markdown)

v4.5.2

Compare Source

Patch Changes
  • Ensure all file paths use forward slashes in windows (#​782).

v4.5.1

Compare Source

Patch Changes
  • Correctly handle package index paths (#​782).
  • Make all options optional in PluginOptions interface (#​781).

v4.5.0

Compare Source

This release introduces support for TypeDoc 0.28 that contains several under-the-hood breaking API changes.

From a consumer perspective there should be no direct breaking change from the plugin itself, but there are some architectural and output structure changes to consider.

Architectural Changes
  • This plugin now utilizes TypeDoc's router feature. This implementation replaces the now deprecated "outputFileStrategy" option. "outputFileStrategy" is still supported for now, but will now point to the "member" and "module" router keys respectively. Further details are contained in the documentation website.
  • Please note that separate strategies for output generation in different packages (when entryPointStrategy=packages) is no longer possible with this new architecture.
Structural Changes
  • As per TypeDoc model updates, Object literal Type Alias members are now rendered in groups ("Properties", "Methods") etc rather than under a single "Type Declaration" heading.
  • A new option "typeAliasPropertiesFormat" has been exposed to place properties rendered from the updated structure to a table format.
  • Type parameter list views have been updated to separate items with markdown headings for consistency and to improve readability when parameters have detailed explanations or complex properties. If type parameters are straightforward and few in number switching to typeParametersFormat=table might be preferable.
Minor Changes
  • Implemented custom routers for plugin to support TypeDoc 0.28 router implementation.
  • Added "typeAliasPropertiesFormat" option to support TypeDoc 0.28 updated behaviour for Object literal type alias types.
Patch Changes
  • Mark object properties as optional in PluginOptions interface (#​777).

v4.4.2

Compare Source

Patch Changes
  • Handle duplicate symbols with leading underscores.
  • Correctly flag optional nested parameters (#​765).
  • Introduced ja theme translations as per TypeDoc 0.27.7.
  • Expose anchors to relative document links (thanks @​matus-vacula).

Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

Rebasing: Whenever PR is behind base branch, 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 was generated by Mend Renovate. View the repository job log.

Copy link

changeset-bot bot commented Feb 10, 2025

⚠️ No Changeset found

Latest commit: 7bc2dbc

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

Click 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

@renovate renovate bot changed the title fix(deps): update dependency typedoc-plugin-markdown to v4.4.2 fix(deps): update dependency typedoc-plugin-markdown to v4.5.0 Mar 16, 2025
@renovate renovate bot force-pushed the renovate/typedoc-plugin-markdown-4.x-lockfile branch from 500617d to d33c7d5 Compare March 16, 2025 02:44
@renovate renovate bot changed the title fix(deps): update dependency typedoc-plugin-markdown to v4.5.0 fix(deps): update dependency typedoc-plugin-markdown to v4.5.1 Mar 19, 2025
@renovate renovate bot force-pushed the renovate/typedoc-plugin-markdown-4.x-lockfile branch from d33c7d5 to 4ec5f52 Compare March 19, 2025 03:15
@renovate renovate bot changed the title fix(deps): update dependency typedoc-plugin-markdown to v4.5.1 fix(deps): update dependency typedoc-plugin-markdown to v4.5.2 Mar 19, 2025
@renovate renovate bot force-pushed the renovate/typedoc-plugin-markdown-4.x-lockfile branch from 4ec5f52 to 7bc2dbc Compare March 19, 2025 12:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

0 participants