chore(deps): update dependency typedoc-plugin-markdown to v4

[cu-infra-svc-git]

This PR contains the following updates:

Package	Change	Age	Adoption	Passing	Confidence
typedoc-plugin-markdown (source)	^3.16.0 -> ^4.0.0

---

Release Notes

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

v4.0.0

Compare Source

v4 is a major release that includes a number of bug fixes, new features and UI improvements.

Architectural Changes

• Handlebars as a dependency has been removed.
• Updated customization model with the ability to set hooks, events and custom theming.
• Exposed navigation structure.

Features

• Updated output file structure.
• Improved and cleaner UI.
• A set of updated and additional new options with comprehensive documentation.
• Exported option types and JSON schema.

Structural Changes

• Each module member is now output to its own file by default. See option --outputFileStrategy. To achieve the same output as v3 (whereby only Classes, Enums and Interfaces have their own file), set the option membersWithOwnFile option.
• Parameters are output as a list by default. To achieve the same output as v3 (where parameters are output as a table), use option --parametersFormat=table.

Breaking Changes

• Because the file structure has changed you may need to update any cross references to files in your documentation.
• Setting theme to "markdown" is no longer required and should be removed.
• The option indexTitle has been removed. Please use the "title.indexPage" key with option --textContentMappings.
• The option allReflectionsHaveOwnDocument has been removed (this behaviour is now the default). Please see option outputFileStrategy](/docs/options#outputfilestrategy).
• The option entryDocument has been renamed to entryFileName to better reflect its purpose.
• The option namedAnchors has been renamed to useHTMLAnchors to better reflect its purpose.
• The option hideInPageTOC has been removed. In-page TOC are no longer included by default. You can include in-page TOCs by using typedoc-plugin-remark and the remark-toc plugin.
• The option objectLiteralTypeDeclarationStyle has been removed. Please use option --typeDeclarationFormat=list.

Bug Fixes

• Duplication in callback/callable/function properties. (#​581).
• @​experimental / @​internal annotations. (#​556)
• Fix events output and strike-through deprecated items. (#​534)
• Class static functions are no longer marked. (#​533)
• @​example block not rendered with Headline (#​501)
• Support for categories (#​499)
• Correctly resolve package readme urls from member pages. (#​483)
• Add the ability to add a separate frontmatter for readme file. (#​469)
• Items in tables are not linkable. (#​463)
• Custom i18n texts. (#​458)
• How to improve the formatting for types?. (#​456)
• How to change title format. (#​450)
• Export Docusaurus plugin options type. (#​440)
• How to export interface as a table. (#​403)
• Broken Link caused by Typescript class being defined in an index file. (#​402)
• Markdown plugin inserts unnecessary escape characters. (#​398)
• Potential bug with optional function argument. (#​396)
• Respect monorepo readmeFile configuration (#​383)
• Embed all objects under a Module/Namespace onto single page. (#​338)
• Extra spaces when merging lines in a table. (#​331)
• Does not support namespace (or module) and interface with same name. (#​300)
• Integration with VitePress? (#​287)
• Typedoc comments with text wrapped in < and > breaks Docusaurus Markdown parser. (#​276)
• Navigation support? (#​262)
• Sidebar Category Support? (#​213)
• Properties as Table like function properties. (#​109)
• Provide a link/excerpt/screenshot to a demo/example rendered output (#​102)

---

Earlier changelog entries can be found in CHANGELOG_ARCHIVE.md.

v3.17.1

Compare Source

• Prevent escaping of angle brackets in toc (#​495)

v3.17.0

Compare Source

Features

• Support MDXv2

---

Configuration

📅 Schedule: Branch creation - "before 1am on Monday" (UTC), 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 has been generated by Renovate Bot.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (24bb349) to head (8014a86).

Additional details and impacted files

@@            Coverage Diff            @@
##              main       #21   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            2         2           
  Lines          132       132           
  Branches        10        10           
=========================================
  Hits           132       132           

---

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 24bb349...8014a86. Read the comment docs.

[cu-infra-svc-git]

Edited/Blocked Notification

Renovate will not automatically rebase this PR, because it does not recognize the last commit author and assumes somebody else may have edited the PR.

You can manually request rebase by checking the rebase/retry box above.

⚠️ Warning: custom changes will be lost.