Skip to content

chore: Bump typedoc-plugin-markdown from 3.17.1 to 4.14.1 - #106

Open
dependabot[bot] wants to merge 1 commit into
mainfrom
dependabot/npm_and_yarn/typedoc-plugin-markdown-4.14.1
Open

dependabot[bot] wants to merge 1 commit into
mainfrom
dependabot/npm_and_yarn/typedoc-plugin-markdown-4.14.1

Conversation

@dependabot

@dependabot dependabot Bot commented on behalf of github Oct 23, 2026 •

Copy link
Copy Markdown
Contributor

Bumps typedoc-plugin-markdown from 3.17.1 to 4.14.1.

Release notes

Sourced from typedoc-plugin-markdown's releases.

typedoc-plugin-markdown@4.14.1

Patch Changes

  • Render constructor types with their new and abstract keywords instead of as function types (#940).
  • Parenthesise function, constructor, union and conditional types inside intersections, so A & (() => void) is no longer rendered as A & () => void (#940).
  • With useCodeBlocks, mark optional members with ? instead of an optional keyword, which is not valid TypeScript.
  • With useCodeBlocks, quote property and method names that are not identifiers, so "prop.with.dot": string is no longer rendered as prop.with.dot: string.
  • With useCodeBlocks, render "Overrides", "Implementation of" and "Inherited from" references to external members as inline code instead of code blocks, on one line.

typedoc-plugin-markdown@4.14.0

Minor Changes

This release is a sweep of rendering fixes checked against TypeDoc's own output. Most of them change the generated markdown, so expect diffs when docs are regenerated. No option or public type changes.

  • Render methods inside object types with their call signatures, every overload and their comments, instead of only the first overload's return type. This applies to expanded objects (expandObjects), properties tables, parameter tables and lists, and type declaration tables, where nested methods also keep their path prefix (inner.fn()) (#908).
  • Render anchors for type parameters, including those of methods, so links to them resolve. They are slugged from the type parameter's name, prefixed with type-parameter- when parametersFormat is a table so they no longer shift member anchors, and omitted when parametersFormat is none (#909).
  • Fire the page.begin, page.end, content.begin and content.end hooks on the readme page and on document pages, which previously fired no hooks, so content injected through them (such as front matter) now appears there too. The index.page.begin and index.page.end hooks still fire on the project page as before.
  • Change the structure of several page sections: named tuple members are rendered with their names and optional markers ([first: string, second?: number]); each parent under "Extends" is its own item instead of being joined with .; the object members of an intersection sit under a single "Type Declaration" heading after the type parameters; and each document group lists only its own documents.
  • Remove #, ? and \ from generated file names, so links to pages such as a document titled FAQ: What's new? [#1](https://github.com/typedoc2md/typedoc-plugin-markdown/tree/HEAD/packages/typedoc-plugin-markdown/issues/1) resolve, and keep names made only of underscores, so export function _() is written to functions/_.md instead of an empty file name.

Patch Changes

  • Apply anchorPrefix to links that point to another page, and only once with the kind-dir and structure-dir routers, and link constructors to their localised heading (e.g. #konstruktor) when lang is not English.
  • Keep literal values verbatim in code blocks (useCodeBlocks) and escape backslashes in text outside code, so '[a](https://github.com/typedoc2md/typedoc-plugin-markdown/tree/HEAD/packages/typedoc-plugin-markdown/blob/HEAD/b)', '&lt;b&gt;' and 'C:\\temp' display as written instead of as "a", "<b>" and C:\temp.
  • List a class under every hierarchy root it extends or implements on the hierarchy summary page, instead of only the first.
  • Encode relative media links, so a linked file with spaces in its name still resolves.
  • Match entryModule against modules only, so a function or class sharing the module's name keeps its page, find the entry module when project documents are present, and write the readme page once with the core routers and mergeReadme instead of a second page at the same URL.
  • Render the return type of a signature when it is an array or intersection of documented object types or an @expand type, instead of an empty "Returns" section, and render parameters and return types that reference an @expand type as the type instead of listing union members separately.
  • Wrap function, intersection, conditional and type operator types in parentheses when they are array elements or optional tuple elements, e.g. (() => void)[] instead of () => void[].
  • Strike through deprecated nested members in properties and type declaration tables, as list format already does.
  • Mark a parameter as optional (a?) in tables when it has a default value, as the signature title and list format already do, and only by its own flag for members of an object parameter instead of every row after the first optional one. Show the default value of a union-typed parameter and the type of an object parameter with no members to list (such as an index signature alone) in list format, and show an elided property default as ... in properties tables instead of undefined.
  • Keep pages inside the output directory when a module or document name contains parent directory segments.
  • Escape | in table cells (including inside code spans, as GFM tables require) so it no longer splits a row into extra columns. The rendered text still shows a plain |.
  • Show every modifier of a property (e.g. protected static readonly), not only the first one found.

typedoc-plugin-markdown@4.13.1

Patch Changes

  • Load plugin translations for the merge entry point strategy (#900).
  • Translate the @example heading in de, fr and ko (#900).
  • Fix truncated option descriptions in the published JSON schema and type declarations.
  • Fixed broken links on Windows when using excludeScopesInPaths (#903).

typedoc-plugin-markdown@4.13.0

Minor Changes

  • add a parametersFormat: "none" option to completely drop the parameter list/table and its heading (#876) - thanks @​Jym77.
  • expand type parameters in signatures when expandParameters is set (#875) - thanks @​Jym77.

Patch Changes

... (truncated)

Changelog

Sourced from typedoc-plugin-markdown's changelog.

4.14.1 (2026-10-19)

Patch Changes

  • Render constructor types with their new and abstract keywords instead of as function types (#940).
  • Parenthesise function, constructor, union and conditional types inside intersections, so A & (() => void) is no longer rendered as A & () => void (#940).
  • With useCodeBlocks, mark optional members with ? instead of an optional keyword, which is not valid TypeScript.
  • With useCodeBlocks, quote property and method names that are not identifiers, so "prop.with.dot": string is no longer rendered as prop.with.dot: string.
  • With useCodeBlocks, render "Overrides", "Implementation of" and "Inherited from" references to external members as inline code instead of code blocks, on one line.

4.14.0 (2026-10-13)

Minor Changes

This release is a sweep of rendering fixes checked against TypeDoc's own output. Most of them change the generated markdown, so expect diffs when docs are regenerated. No option or public type changes.

  • Render methods inside object types with their call signatures, every overload and their comments, instead of only the first overload's return type. This applies to expanded objects (expandObjects), properties tables, parameter tables and lists, and type declaration tables, where nested methods also keep their path prefix (inner.fn()) (#908).
  • Render anchors for type parameters, including those of methods, so links to them resolve. They are slugged from the type parameter's name, prefixed with type-parameter- when parametersFormat is a table so they no longer shift member anchors, and omitted when parametersFormat is none (#909).
  • Fire the page.begin, page.end, content.begin and content.end hooks on the readme page and on document pages, which previously fired no hooks, so content injected through them (such as front matter) now appears there too. The index.page.begin and index.page.end hooks still fire on the project page as before.
  • Change the structure of several page sections: named tuple members are rendered with their names and optional markers ([first: string, second?: number]); each parent under "Extends" is its own item instead of being joined with .; the object members of an intersection sit under a single "Type Declaration" heading after the type parameters; and each document group lists only its own documents.
  • Remove #, ? and \ from generated file names, so links to pages such as a document titled FAQ: What's new? [#1](https://github.com/typedoc2md/typedoc-plugin-markdown/tree/HEAD/packages/typedoc-plugin-markdown/issues/1) resolve, and keep names made only of underscores, so export function _() is written to functions/_.md instead of an empty file name.

Patch Changes

  • Apply anchorPrefix to links that point to another page, and only once with the kind-dir and structure-dir routers, and link constructors to their localised heading (e.g. #konstruktor) when lang is not English.
  • Keep literal values verbatim in code blocks (useCodeBlocks) and escape backslashes in text outside code, so '[a](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/b)', '&lt;b&gt;' and 'C:\\temp' display as written instead of as "a", "<b>" and C:\temp.
  • List a class under every hierarchy root it extends or implements on the hierarchy summary page, instead of only the first.
  • Encode relative media links, so a linked file with spaces in its name still resolves.
  • Match entryModule against modules only, so a function or class sharing the module's name keeps its page, find the entry module when project documents are present, and write the readme page once with the core routers and mergeReadme instead of a second page at the same URL.
  • Render the return type of a signature when it is an array or intersection of documented object types or an @expand type, instead of an empty "Returns" section, and render parameters and return types that reference an @expand type as the type instead of listing union members separately.
  • Wrap function, intersection, conditional and type operator types in parentheses when they are array elements or optional tuple elements, e.g. (() => void)[] instead of () => void[].
  • Strike through deprecated nested members in properties and type declaration tables, as list format already does.
  • Mark a parameter as optional (a?) in tables when it has a default value, as the signature title and list format already do, and only by its own flag for members of an object parameter instead of every row after the first optional one. Show the default value of a union-typed parameter and the type of an object parameter with no members to list (such as an index signature alone) in list format, and show an elided property default as ... in properties tables instead of undefined.
  • Keep pages inside the output directory when a module or document name contains parent directory segments.
  • Escape | in table cells (including inside code spans, as GFM tables require) so it no longer splits a row into extra columns. The rendered text still shows a plain |.
  • Show every modifier of a property (e.g. protected static readonly), not only the first one found.

4.13.1 (2026-09-18)

Patch Changes

  • Load plugin translations for the merge entry point strategy (#900).
  • Translate the @example heading in de, fr and ko (#900).
  • Fix truncated option descriptions in the published JSON schema and type declarations.
  • Fixed broken links on Windows when using excludeScopesInPaths (#903).

4.13.0 (2026-08-25)

Minor Changes

... (truncated)

Commits
  • bc9bce5 Version Packages
  • 054a927 fix(core): render inheritance references to external members as inline code
  • 6b1f385 test(core): check that ts code blocks in fixture output are valid TypeScript
  • 1242c67 test(core): build HTML output for the utils fixtures
  • bd860c4 fix(core): render optional and non-identifier member names as valid TypeScrip...
  • a167dd0 fix(core): render constructor and function types in intersections as valid Ty...
  • 2fcdba6 chore(release): date and sync changelogs
  • 2fce902 Version Packages
  • 2c91a37 fix(core): keep pages inside the output directory and insert names containing...
  • 5e456ba refactor(core): share the anchor title logic between member and type paramete...
  • Additional commits viewable in compare view
Maintainer changes

This version was pushed to npm by GitHub Actions, a new releaser for typedoc-plugin-markdown since your current version.


@dependabot
dependabot Bot requested a review from a team as a code owner October 23, 2026 13:04
@dependabot dependabot Bot added dependencies Pull requests that update a dependency file javascript Pull requests that update javascript code labels Oct 23, 2026
Bumps [typedoc-plugin-markdown](https://github.com/typedoc2md/typedoc-plugin-markdown/tree/HEAD/packages/typedoc-plugin-markdown) from 3.17.1 to 4.14.1.
- [Release notes](https://github.com/typedoc2md/typedoc-plugin-markdown/releases)
- [Changelog](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/CHANGELOG.md)
- [Commits](https://github.com/typedoc2md/typedoc-plugin-markdown/commits/typedoc-plugin-markdown@4.14.1/packages/typedoc-plugin-markdown)

---
updated-dependencies:
- dependency-name: typedoc-plugin-markdown
  dependency-version: 4.14.1
  dependency-type: direct:development
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
@dependabot
dependabot Bot force-pushed the dependabot/npm_and_yarn/typedoc-plugin-markdown-4.14.1 branch from 2326fd8 to 8604016 Compare October 27, 2026 14:16
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 javascript Pull requests that update javascript code

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants