Skip to content

Conversation

dependabot[bot]
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github Apr 14, 2025

Bumps typedoc-plugin-markdown from 3.17.1 to 4.6.2.

Release notes

Sourced from typedoc-plugin-markdown's releases.

[email protected]

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.

[email protected]

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.

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

... (truncated)

Changelog

Sourced from typedoc-plugin-markdown's changelog.

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

  • 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

... (truncated)

Commits
  • 7456f3f Version Packages
  • ef583ee fix(core): added support for@group none, @category none and @disableGroups
  • aef5620 fix(core): expose full declaration for returned union types
  • 6543717 chore(docs): tweaked parametersFormat description
  • c10f634 fix(core): move isOptional flag inside backTicks
  • 280c047 chore(docs): updated docs
  • fe98081 Version Packages
  • cd293b6 fix(core): correctly handle overloaded function display in list and table views
  • 83404ad fix(core): correctly render html table when interfacePropertiesFormat=htmlTable
  • 43079f0 chore(docs): updated docs
  • 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)

Bumps [typedoc-plugin-markdown](https://github.com/typedoc2md/typedoc-plugin-markdown/tree/HEAD/packages/typedoc-plugin-markdown) from 3.17.1 to 4.6.2.
- [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/[email protected]/packages/typedoc-plugin-markdown)

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

Signed-off-by: dependabot[bot] <[email protected]>
@dependabot dependabot bot added dependencies Pull requests that update a dependency file javascript Pull requests that update javascript code labels Apr 14, 2025
Copy link
Contributor Author

dependabot bot commented on behalf of github Apr 28, 2025

Superseded by #214.

@dependabot dependabot bot closed this Apr 28, 2025
@dependabot dependabot bot deleted the dependabot/npm_and_yarn/typedoc-plugin-markdown-4.6.2 branch April 28, 2025 11:08
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.

0 participants