Update dependency typedoc-plugin-markdown to v4.10.0

[renovate]

This PR contains the following updates:

Package	Change	Age	Confidence
typedoc-plugin-markdown (source)	4.2.7 → 4.10.0

---

Release Notes

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

v4.10.0

Compare Source

Minor Changes

• A JSON schema to be consumed by typedoc.json is now published to the package root.
• Mark parameters with default values as optional, matching the default TypeDoc theme.

Patch Changes

• Fixed markdownlint errors related to empty table cells and invalid link fragments.
• Anchors inside table cells (when property formats equal "table") are now namespaced by reflection kind (for example property-foo) to prevent collisions with Markdown heading slugs and ensure stable in-page links (#​856).
• Resolve "does not have an anchor but one was requested" warnings in verbose log mode (#​850).
• Guard against undefined types causing errors in complex types in tables (thanks @​ilyabo).

v4.9.0

Compare Source

Minor Changes

• Exposed new option navigationJson that can be used to write navigation structure as JSON to disk.

Patch Changes

• Remove type params from inline reflection titles when router=module to resolve anchoring issues (#​843).

v4.8.1

Compare Source

Patch Changes

• Correctly handle empty markdown links (#​836).

v4.8.0

Compare Source

Minor Changes

• Exposed additional placeholders in pageTitleTemplates and adjusted default templates (#​831).
• Tweaked the format of abstract class page titles to include the translated abstract keyword (e.g., "Abstract Class: MyClass") for improved readability.
• Added strikeDeprecatedPageTitles option.

Patch Changes

• Fix incorrect link fragments (#​832).

v4.7.1

Compare Source

Patch Changes

• Escape square brackets in index signature types (#​829).
• Fix missing segments in declaration titles that contain periods.

v4.7.0

Compare Source

Minor Changes

• Added useCustomAnchors and customAnchorsFormat options - thanks @​ocavue.

Patch Changes

• Fix incorrect overload function comments (#​827).

v4.6.4

Compare Source

Patch Changes

• Added theme translations for "de" locale.
• Fix navigation items without group or categories (@group/@​category=none) (#​815).
• Correctly handle sidebar groups for packages with merged modules.

v4.6.3

Compare Source

Patch Changes

• Correctly handle group title in pageTitleTemplates callback (#​807).
• Format of optional type and getter/setter (#​804) - thanks @​normanzb.

v4.6.2

Compare Source

Patch Changes

• Expose full declaration for returned union types (#​799).
• Move isOptional flag inside backTicks (#​797) - thanks @​LekoArts.
• Added support for TypeDoc's v0.28.2 features @group none, @category none and @disableGroups.

v4.6.1

Compare Source

Patch Changes

• Correctly render html table when interfacePropertiesFormat=htmlTable (#​794).
• Correctly handle overloaded function display in list and table views (#​793).
• Expose comments and signatures to index signature members.
• Wrap default values in back ticks on table views to be consistent with list views.
• Append semi colons to signature in code blocks.

v4.6.0

Compare Source

This release continues the effort to further align to TypeDoc’s default theme, with improvements that make the plugin more consistent and predictable.

Architectural Changes

• Introduced support for TypeDoc core routers. This allows output files to be generated in the same structure as the default HTML theme, while still using the plugin’s Markdown theme.
• Exported routers to the public API, enabling customization by other plugins.

Structural Changes

• Package readme's (when "entryPointStrategy" is "packages") are now merged with the package index page producing a single entrypoint for packages with an associated readme.
  This aligns with the default theme and improves navigation.
• To support core routers, a "Hierarchy Summary" page has been introduced to all routers. This feature is turned off by default but can be enabled by setting "includeHierarchySummary" to "true".
• When "includeHierarchySummary" is "true", symbols with an available hierarchy now include an associated "Hierarchy" Markdown heading with a "View Summary" link as per the default theme.
• Class constructor headings now read "Constructor". This aligns to the TypeDoc internal reflection name and fixes issues with internal anchoring not resolving correctly.

Minor Changes

• Implemented support for consuming TypeDoc core routers.
• Exported routers to public api.
• Implemented a hierarchy summary page as per default theme.
• Updated "Constructor" titles of classes to fix internal anchor issues.

Patch Changes

• Fix incompatibility when used with "outputs" (#​788).
• Utilize "anchorPrefix" option to ensure unique anchors linking if required (#​764).

v4.5.2

Compare Source

Patch Changes

• Ensure all file paths use forward slashes in windows (#​782).

v4.5.1

Compare Source

Patch Changes

• Correctly handle package index paths (#​782).
• Make all options optional in PluginOptions interface (#​781).

v4.5.0

Compare Source

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

v4.4.2

Compare Source

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

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.

Architectural Changes

Please see the 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.

Structural Changes

• Parameters list views have been updated to separate items 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.

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

v4.2.10

Compare Source

Patch Changes

• Enhanced the formatting and structure of accessor output (#​711)

v4.2.9

Compare Source

Patch Changes

• Expose @return block tags on declarations (#​694)
• Add parentheses on function names in type declaration table views (#​696)

v4.2.8

Compare Source

Patch Changes

• Fix missing slash when public path is prefixed with http (#​688)

---

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.

[chatgpt-codex-connector]

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: c1f322fe50

ℹ️ About Codex in GitHub

Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you

• Open a pull request for review
• Mark a draft as ready
• Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".

[chatgpt-codex-connector]

Align typedoc with plugin peer requirement

This change upgrades typedoc-plugin-markdown to 4.10.0 but leaves typedoc pinned to 0.26.8; the updated lockfile shows 4.10.0 now declares a typedoc: 0.28.x peer requirement (pnpm-lock.yaml:1575). Keeping this unsupported pair can break generate-ref/TypeDoc execution (and can fail installation where peer checks are enforced), so the dependency bump is incomplete unless typedoc is upgraded to a compatible 0.28.x release or the plugin stays on a 0.26.x-compatible version.

Useful? React with 👍 / 👎.