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

Update dependency typedoc-plugin-markdown to v4.4.1 #1174

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

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Nov 30, 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 - "* * * * 0,6" (UTC), Automerge - At any time (no schedule defined).

🚦 Automerge: Enabled.

Rebasing: Whenever PR is behind base branch, 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.

Copy link

cloudflare-workers-and-pages bot commented Nov 30, 2024

Deploying theemo with  Cloudflare Pages  Cloudflare Pages

Latest commit: f9f99d1
Status:🚫  Build failed.

View logs

@renovate renovate bot added dependencies Pull requests that update a dependency file internal Internal change labels Nov 30, 2024
@renovate renovate bot force-pushed the renovate/typedoc-plugin-markdown-4.x branch 6 times, most recently from 0286734 to 3c80514 Compare December 2, 2024 01:23
@renovate renovate bot changed the title Update dependency typedoc-plugin-markdown to v4.3.0 Update dependency typedoc-plugin-markdown to v4.3.1 Dec 2, 2024
@renovate renovate bot force-pushed the renovate/typedoc-plugin-markdown-4.x branch 8 times, most recently from d7b6192 to fce302e Compare December 8, 2024 19:12
@renovate renovate bot changed the title Update dependency typedoc-plugin-markdown to v4.3.1 Update dependency typedoc-plugin-markdown to v4.3.2 Dec 8, 2024
@renovate renovate bot force-pushed the renovate/typedoc-plugin-markdown-4.x branch 5 times, most recently from b97ac06 to 9a948c1 Compare December 19, 2024 02:03
@renovate renovate bot changed the title Update dependency typedoc-plugin-markdown to v4.3.2 Update dependency typedoc-plugin-markdown to v4.3.3 Dec 19, 2024
@renovate renovate bot force-pushed the renovate/typedoc-plugin-markdown-4.x branch 5 times, most recently from 03847c4 to 801c366 Compare December 28, 2024 04:26
@renovate renovate bot force-pushed the renovate/typedoc-plugin-markdown-4.x branch 6 times, most recently from 32add44 to 68f3c99 Compare December 31, 2024 01:49
@renovate renovate bot changed the title Update dependency typedoc-plugin-markdown to v4.3.3 Update dependency typedoc-plugin-markdown to v4.4.0 Dec 31, 2024
@renovate renovate bot force-pushed the renovate/typedoc-plugin-markdown-4.x branch from 68f3c99 to 044e432 Compare January 1, 2025 16:50
@renovate renovate bot changed the title Update dependency typedoc-plugin-markdown to v4.4.0 Update dependency typedoc-plugin-markdown to v4.4.1 Jan 1, 2025
@renovate renovate bot force-pushed the renovate/typedoc-plugin-markdown-4.x branch 7 times, most recently from 3a3ccdd to 13b2bdb Compare January 6, 2025 03:48
@renovate renovate bot force-pushed the renovate/typedoc-plugin-markdown-4.x branch 8 times, most recently from de55bd0 to f42f497 Compare January 18, 2025 05:16
@renovate renovate bot force-pushed the renovate/typedoc-plugin-markdown-4.x branch 4 times, most recently from 2808471 to c81ebb7 Compare January 22, 2025 00:41
@renovate renovate bot force-pushed the renovate/typedoc-plugin-markdown-4.x branch from c81ebb7 to f9f99d1 Compare January 22, 2025 04:57
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 internal Internal change
Projects
None yet
Development

Successfully merging this pull request may close these issues.

0 participants