Skip to content

Conversation

@dependabot
Copy link

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

Bumps typedoc-plugin-markdown from 3.17.1 to 4.5.2.

Release notes

Sourced from typedoc-plugin-markdown's releases.

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

... (truncated)

Changelog

Sourced from typedoc-plugin-markdown's changelog.

4.5.2

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

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

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)

... (truncated)

Commits
  • 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
  • 5b295de chore(docs): updated changesets
  • 6297bde chore(docs): tweaked changelog
  • 5b5d1a7 chore(docs): tweaked changelog
  • 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.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/typedoc-plugin-markdown@4.5.2/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 19, 2025
@changeset-bot
Copy link

changeset-bot bot commented Mar 19, 2025

⚠️ No Changeset found

Latest commit: 5023001

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 24, 2025

Superseded by #71.

@dependabot dependabot bot closed this Mar 24, 2025
@dependabot dependabot bot deleted the dependabot/npm_and_yarn/typedoc-plugin-markdown-4.5.2 branch March 24, 2025 23: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