Skip to content

Conversation

@dependabot
Copy link

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

Bumps typedoc-plugin-markdown from 3.17.1 to 4.5.0.

Release notes

Sourced from typedoc-plugin-markdown's releases.

typedoc-plugin-markdown@4.5.0

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

typedoc-plugin-markdown@4.4.2

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

typedoc-plugin-markdown@4.4.1

Patch Changes

  • Correctly display inline objects for tuple optional types (#745).
  • Expose isDeprecated flag to navigation category items.

typedoc-plugin-markdown@4.4.0

Minor Changes

  • Expose "isDeprecated" flag to navigation model (#747).
  • Moved source link inline and exposed to all parent symbols (#746).
  • Remove extraneous "Index" headings.
  • Always assign HTML anchor ids to linkable symbols within table rows.

Patch Changes

  • Always display inline object for tuple types (#745).
  • Strikeout deprecated items in reflection indexes.
  • Fix inline formatting of types when when "useCodeBlocks" is used (#742).
  • Expose group descriptions to module indexes.
  • Expose global documents with "packages" entryPointStrategy.

typedoc-plugin-markdown@4.3.3

Patch Changes

  • Correctly handle anchor resolutions with table formats.
  • Fix invalid typescript syntax for type aliases inside declaration code blocks when "useCodeBlocks" is true (#741).

typedoc-plugin-markdown@4.3.2

Patch Changes

  • Enable {@link} resolution on type alias properties (#732).

... (truncated)

Changelog

Sourced from typedoc-plugin-markdown's changelog.

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

  • 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 "kind-structure" 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).

4.4.2 (2025-02-09)

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

4.4.1 (2025-01-01)

Patch Changes

  • Correctly display inline objects for tuple optional types (#745).
  • Expose isDeprecated flag to navigation category items.

4.4.0 (2024-12-30)

This release introduces structural enhancements to the user interface and bug fixes to enhance overall functionality.

Structural Changes

  • Source file links are now placed inline rather than under separate "Defined in" headings. This change aligns with the default HTML theme, generates more compact output, and improves the readability of automatically generated Table of Contents (TOCs).
  • Extraneous "Index" headings on module landing pages have been removed, bringing the structure in line with the default HTML theme and reducing unnecessary clutter.

... (truncated)

Commits
  • e4bf064 Version Packages
  • ec572d4 feat(core): typedoc 0.28 compatibility fixes and enhancements
  • c50eb66 chore(all): fix models script
  • 93e43a2 docs(all): updated dev docs
  • 1000c9c fix(core): updated changelog date
  • e3297aa Version Packages
  • 69321ce fix(core): introduced ja theme translations
  • 7dff921 chore(core): updated packages
  • 67100a8 fix(core): correctly flag optional nested parameters
  • b910fba fix(core): handle duplicate symbols with leading underscores
  • 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.5.0.
- [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.5.0/packages/typedoc-plugin-markdown)

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

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 Mar 17, 2025
@changeset-bot
Copy link

changeset-bot bot commented Mar 17, 2025

⚠️ No Changeset found

Latest commit: e563a86

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

@dependabot @github
Copy link
Author

dependabot bot commented on behalf of github Mar 19, 2025

Superseded by #68.

@dependabot dependabot bot closed this Mar 19, 2025
@dependabot dependabot bot deleted the dependabot/npm_and_yarn/typedoc-plugin-markdown-4.5.0 branch March 19, 2025 21:34
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