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

Bump typedoc-plugin-markdown from 4.4.2 to 4.6.0 #4001

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

Conversation

dependabot[bot]
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github Mar 24, 2025

Bumps typedoc-plugin-markdown from 4.4.2 to 4.6.0.

Release notes

Sourced from typedoc-plugin-markdown's releases.

[email protected]

Minor Changes

  • Implemented support for consuming TypeDoc core routers.
  • Exported routers to public api.
  • Implemented a hierarchy summary page as per default theme.
  • Updated "Constructor" titles of classes to fix internal anchor issues.

Patch Changes

  • Fix incompatibility when used with "outputs" (#788).
  • Utilize "anchorPrefix" option to ensure unique anchors linking if required (#764).

[email protected]

Patch Changes

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

[email protected]

Patch Changes

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

[email protected]

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).
Changelog

Sourced from typedoc-plugin-markdown's changelog.

4.6.0 (2025-03-23)

This release continues the effort to further align to TypeDoc’s default theme, with improvements that make the plugin more consistent and predictable.

Architectural Changes

  • Introduced support for TypeDoc core routers. This allows output files to be generated in the same structure as the default HTML theme, while still using the plugin’s Markdown theme.
  • Exported routers to the public API, enabling customization by other plugins.

Structural Changes

  • Package readme's (when "entryPointStrategy" is "packages") are now merged with the package index page producing a single entrypoint for packages with an associated readme. This aligns with the default theme and improves navigation.
  • To support core routers, a "Hierarchy Summary" page has been introduced to all routers. This feature is turned off by default but can be enabled by setting "includeHierarchySummary" to "true".
  • When "includeHierarchySummary" is "true", symbols with an available hierarchy now include an associated "Hierarchy" Markdown heading with a "View Summary" link as per the default theme.
  • Class constructor headings now read "Constructor". This aligns to the TypeDoc internal reflection name and fixes issues with internal anchoring not resolving correctly.

Minor Changes

  • Implemented support for consuming TypeDoc core routers.
  • Exported routers to public api.
  • Implemented a hierarchy summary page as per default theme.
  • Updated "Constructor" titles of classes to fix internal anchor issues.

Patch Changes

  • Fix incompatibility when used with "outputs" (#788).
  • Utilize "anchorPrefix" option to ensure unique anchors linking if required (#764).

4.5.2 (2025-03-19)

Patch Changes

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

4.5.1 (2025-03-18)

Patch Changes

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

4.5.0 (2025-03-16)

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

... (truncated)

Commits
  • bbcb2c9 Version Packages
  • c847715 feat(core): core router support and further theme alignment to core theme
  • 28ecc72 chore(docs): updated scripts
  • 566d44b Version Packages
  • 85c29ac fix(core): ensure all file paths use forward slashes in windows
  • 5fdf685 chore(docs): updated changelog date
  • e09b994 Version Packages
  • a915aa5 refactor(core): rename default router to "member"
  • 146855f fix(core): correctly handle package index paths
  • 24c1dea fix(core): make all options optional in PluginOptions interface
  • Additional commits viewable in compare view

Dependabot compatibility score

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)

@dependabot dependabot bot added dependencies Pull requests that update a dependency file javascript Pull requests that update javascript code labels Mar 24, 2025
@dependabot dependabot bot force-pushed the dependabot/npm_and_yarn/typedoc-plugin-markdown-4.6.0 branch 3 times, most recently from c6d5077 to 110e6f3 Compare March 31, 2025 16:01
@dependabot dependabot bot force-pushed the dependabot/npm_and_yarn/typedoc-plugin-markdown-4.6.0 branch from 110e6f3 to 9baa750 Compare March 31, 2025 20:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Pull requests that update a dependency file javascript Pull requests that update javascript code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants