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.4.1 #3026

Draft
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.4.1 age adoption passing confidence

Release Notes

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

v4.4.1

Compare Source

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

v4.4.0

Compare Source

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.
  • Anchor IDs are now applied to linkable symbols within table rows by default. Previously, the useHTMLAnchors option was required, but since there is no alternative way to link to these items, this behaviour is now the default.
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.

v4.3.3

Compare Source

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

v4.3.2

Compare Source

Patch Changes
  • Enable {@​link} resolution on type alias properties (#​732).
  • Remove superfluous name attribute when "useHtmlAnchors" is true..
  • Escape characters inside @link tags.
  • Fixed spacing around inline object declarations.
  • Always expose type arguments of reference types as per default theme (#​733).

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

socket-security bot commented Nov 27, 2024

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

Package New capabilities Transitives Size Publisher
npm/[email protected] None 0 314 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 2847756
🔍 Latest deploy log https://app.netlify.com/sites/tauri-v2/deploys/675da57694e02c00087a3621

@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
@vasfvitor vasfvitor force-pushed the renovate/typedoc-plugin-markdown-4.x-lockfile branch from 2045c10 to 371e6f6 Compare December 5, 2024 19:06
@vasfvitor vasfvitor marked this pull request as draft December 5, 2024 19:57
@renovate renovate bot force-pushed the renovate/typedoc-plugin-markdown-4.x-lockfile branch from 154a15c to b4aa688 Compare December 5, 2024 19:59
@renovate renovate bot changed the title fix(deps): update dependency typedoc-plugin-markdown to v4.3.1 fix(deps): update dependency typedoc-plugin-markdown to v4.3.2 Dec 8, 2024
@renovate renovate bot force-pushed the renovate/typedoc-plugin-markdown-4.x-lockfile branch from b4aa688 to 2847756 Compare December 14, 2024 15:34
@renovate renovate bot changed the title fix(deps): update dependency typedoc-plugin-markdown to v4.3.2 fix(deps): update dependency typedoc-plugin-markdown to v4.3.3 Dec 19, 2024
@renovate renovate bot changed the title fix(deps): update dependency typedoc-plugin-markdown to v4.3.3 fix(deps): update dependency typedoc-plugin-markdown to v4.4.0 Dec 30, 2024
@renovate renovate bot changed the title fix(deps): update dependency typedoc-plugin-markdown to v4.4.0 fix(deps): update dependency typedoc-plugin-markdown to v4.4.1 Jan 1, 2025
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