Skip to content

Bump typedoc-plugin-markdown from 4.2.10 to 4.6.3 #3052

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

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 May 1, 2025

Bumps typedoc-plugin-markdown from 4.2.10 to 4.6.3.

Release notes

Sourced from typedoc-plugin-markdown's releases.

typedoc-plugin-markdown@4.6.3

Patch Changes

  • Correctly handle group title in pageTitleTemplates callback (#807).
  • Format of optional type and getter/setter (#804) - thanks @​normanzb.

typedoc-plugin-markdown@4.6.2

Patch Changes

  • Expose full declaration for returned union types (#799).
  • Move isOptional flag inside backTicks (#797) - thanks @​LekoArts.
  • Added support for TypeDoc's v0.28.2 features @group none, @category none and @disableGroups.

typedoc-plugin-markdown@4.6.1

Patch Changes

  • Correctly render html table when interfacePropertiesFormat=htmlTable (#794).
  • Correctly handle overloaded function display in list and table views (#793).
  • Expose comments and signatures to index signature members.
  • Wrap default values in back ticks on table views to be consistent with list views.
  • Append semi colons to signature in code blocks.

typedoc-plugin-markdown@4.6.0

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

typedoc-plugin-markdown@4.5.2

Patch Changes

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

typedoc-plugin-markdown@4.5.1

Patch Changes

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

typedoc-plugin-markdown@4.5.0

Minor Changes

  • Implemented custom routers for plugin to support TypeDoc 0.28 router implementation.

... (truncated)

Changelog

Sourced from typedoc-plugin-markdown's changelog.

4.6.3 (2025-04-23)

Patch Changes

  • Correctly handle group title in pageTitleTemplates callback (#807).
  • Format of optional type and getter/setter (#804) - thanks @​normanzb.

4.6.2 (2025-04-09)

Patch Changes

  • Expose full declaration for returned union types (#799).
  • Move isOptional flag inside backTicks (#797) - thanks @​LekoArts.
  • Added support for TypeDoc's v0.28.2 features @group none, @category none and @disableGroups.

4.6.1 (2025-04-02)

Patch Changes

  • Correctly render html table when interfacePropertiesFormat=htmlTable (#794).
  • Correctly handle overloaded function display in list and table views (#793).
  • Expose comments and signatures to index signature members.
  • Wrap default values in back ticks on table views to be consistent with list views.
  • Append semi colons to signature in code blocks.

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

... (truncated)

Commits
  • d6c42a4 Version Packages
  • 99baeae fix(core): correctly handle group title in pageTitleTemplates callback
  • c2721a3 chore(core): force pipeline
  • 6e2808e chore(core): force pipelines
  • f6b77b8 feat(remark): remark restructure and improvements
  • 5d00946 Merge branch 'main' of github.com:typedoc2md/typedoc-plugin-markdown
  • a9bbc4f chore(core): fixed phrasing of error message
  • 3d718d1 fix(core): format of optional type and getter/setter
  • 7032ebd chore(docs): updated changelog dates
  • 7456f3f Version Packages
  • 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 will merge this PR once CI passes on it, as requested by @GermanBluefox.


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)

Bumps [typedoc-plugin-markdown](https://github.com/typedoc2md/typedoc-plugin-markdown/tree/HEAD/packages/typedoc-plugin-markdown) from 4.2.10 to 4.6.3.
- [Release notes](https://github.com/typedoc2md/typedoc-plugin-markdown/releases)
- [Changelog](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/CHANGELOG.md)
- [Commits](https://github.com/typedoc2md/typedoc-plugin-markdown/commits/typedoc-plugin-markdown@4.6.3/packages/typedoc-plugin-markdown)

---
updated-dependencies:
- dependency-name: typedoc-plugin-markdown
  dependency-version: 4.6.3
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
@dependabot dependabot bot added dependencies Pull requests that update a dependency file javascript Pull requests that update Javascript code labels May 1, 2025
Copy link
Contributor

@GermanBluefox GermanBluefox left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@dependabot squash and merge

Copy link
Contributor Author

dependabot bot commented on behalf of github May 1, 2025

One of your CI runs failed on this pull request, so Dependabot won't merge it.

Dependabot will still automatically merge this pull request if you amend it and your tests pass.

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.

1 participant