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

fix(deps): update dependency typedoc-plugin-markdown to v4.3.1 #3026

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

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Nov 27, 2024

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
typedoc-plugin-markdown (source) 4.2.10 -> 4.3.1 age adoption passing confidence

Release Notes

typedoc2md/typedoc-plugin-markdown (typedoc-plugin-markdown)

v4.3.1

Compare Source

Patch Changes
  • Expose type declarations to array types.
  • Correctly wrap array of unions in parenthesis (#​719).
  • Omit inline parameter declarations when not useful (#​720).

v4.3.0

Compare Source

This release introduces support for TypeDoc 0.27 and some additional UX features and improvements in addition to some bug fixes.

TypeDoc 0.27 Support

Please see for full TypeDoc changelog for additional information.

There are two TypeDoc breaking changes that might effect users of this plugin:

  • TypeDoc has converted to ESM and therefore all public and local CommonJs plugins will need to be refactored to ESM.
  • TypeScript <5.0 is no longer supported.
UX Changes
  • Parameters list views have been updated to separate params with markdown headings to improve readability when parameters have detailed explanations examples, or sub-properties. If parameters are straightforward and few in number switching to parametersFormat=table might be preferable.
  • Improved structure of curried and overloaded signatures.
  • Page headings have been simplified to simply display project title as per default theme.
Features
  • Exposed formatting with prettier options "formatWithPrettier" and "prettierConfigFile" that enables additional formatting of Markdown if Prettier is installed on a project.
  • Exposed "typeDeclarationVisibility" option to provide a "compact" output structure (#​703).
  • Exposed "pageTitleTemplates" option that accepts a string with placeholder or function arguments to control page titles (#​715).
Patch Changes
  • Improved structure of curried and overloaded signatures (#​714) (#​718)
  • The "hideGroupHeadings" option respects group order (#​716)
  • Handle Optional types correctly (#​719).

Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.


  • If you want to rebase/retry this PR, check this box

This PR was generated by Mend Renovate. View the repository job log.

@renovate renovate bot added the dependencies Does it update a dependency? label Nov 27, 2024
@renovate renovate bot requested a review from a team as a code owner November 27, 2024 13:41
Copy link

New and removed dependencies detected. Learn more about Socket for GitHub ↗︎

Package New capabilities Transitives Size Publisher
npm/[email protected] None 0 312 kB tgreyuk

🚮 Removed packages: npm/[email protected]

View full report↗︎

Copy link

netlify bot commented Nov 27, 2024

Deploy Preview for tauri-v2 failed.

Name Link
🔨 Latest commit 2045c10
🔍 Latest deploy log https://app.netlify.com/sites/tauri-v2/deploys/674721779b506c0008f9b856

@renovate renovate bot changed the title fix(deps): update dependency typedoc-plugin-markdown to v4.3.0 fix(deps): update dependency typedoc-plugin-markdown to v4.3.1 Dec 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Does it update a dependency?
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant