[renovate]

This PR contains the following updates:

Package	Change	Age	Confidence
typedoc (source)	0.28.14 → 0.28.20
typedoc-plugin-markdown (source)	4.9.0 → 4.14.1
typedoc-vitepress-theme (source)	1.1.2 → 1.1.4

---

Release Notes

TypeStrong/TypeDoc (typedoc)

v0.28.20

Compare Source

Features

• Group/category section headings (<h2>) in the default theme now include an id attribute so they can be linked to via fragment identifiers (e.g. modules.html#classes), #​3029.
• Added a @reexport modifier tag to have TypeDoc convert variable/type references as a re-export instead of a new symbol, #​3096.
• API: Introduced generateOutputsBegin and generateOutputsEnd events on Application for plugin use.

Bug Fixes

• When --emit none is used, TypeDoc will now report warnings about missing relative paths previously reported when rendering, #​3078.
• Improved performance via asynchronously performing git and file write operations, more performant JSX rendering, and source code bundling, #​3103.
• A @hidden tag on a constructor parameter-property will now only hide the property, not both the property and the parameter, #​3111.
• Custom @group and @category titles with the same sort weight are now ordered consistently with the alphabetical reflection sort, #​3120.

Thanks!

• @​greymoth-jp
• @​jonathanhefner
• @​kcastellino
• @​Metbcy
• @​StoneCypher
• @​wotan-allfather

v0.28.19

Compare Source

Features

• Added French translations for the TypeDoc interface and help descriptions.
• Added support for triple-slash comment style, which requires exactly three slashes in the comment, #​3089.

Bug Fixes

• Corrected handling of icon caching for custom themes which use SVGs with a larger view box than TypeDoc's default theme.
• Fixed short summary comment handling on module pages when the project source files use Windows line endings, #​3093.

Thanks!

• @​avivkeller
• @​hyosua
• @​marijnh
• @​Pistonight

v0.28.18

Compare Source

Features

• Support TypeScript 6.0, #​3084.

v0.28.17

Compare Source

Bug Fixes

• Improved handling of comments for type aliases which have been declaration merged with functions, #​3064.
• Fixed anchor link generation to members named $, #​3065.
• Corrected typing of the plugin option to permit functions, #​3066.
• Warnings about unused @param tags will now be properly suppressed when they come from declaration files and
  the suppressCommentWarningsInDeclarationFiles option is enabled, #​3070.
• Fixed conversion of types referencing type parameters on functions, #​3071.

Thanks!

• @​pjeby

v0.28.16

Compare Source

Bug Fixes

• Fixed an issue causing TypeDoc to fail to generate documentation when implementing interfaces, #​3052.
• Fixed an issue preventing automatic entry point discovery on Windows, #​3057.
• Improved vertical positioning of text icons, #​3056.
• TypeDoc no longer includes source location information for type literal reflections. This could sometimes
  cause TypeDoc to infer the wrong path when resolving base paths for display.
• Adjusted markdown rendering to allow markdownItLoader to override more rendering #​3055.

Features

• Added support for regions for @include in .tsx, .cjs, and .mjs file references #​3048.
• Comments for TS-in-JS @typedef tags may now specify modifier tags with the inline tag syntax {@mod}.
  This makes it possible to add modifier tags to these members, which previously was not possible as
  TypeScript's parsing stops for these members at the next non-braced tag, #​2916 and #​3050.
• A typedoc-config.schema.json is now included in the root of the package with a JSON schema for TypeDoc's
  configuration file. The schema for the latest version is also published at https://typedoc.org/schema.json
  and will automatically be picked up when writing typedoc.json files if you are using VSCode, #​3054.

Thanks!

• @​a10nik
• @​kozi
• @​Lakuna

v0.28.15

Compare Source

Features

• The gitRevision option now accepts the special value {branch}, which indicates source links should use
  the current git branch for links, #​3041.
• Introduced validation.invalidPath for suppressing warnings caused by referencing relative paths which
  do not exist when building the documentation, #​3033.
• API: Introduced Logger.validationWarning for validation which occurs during conversion rather than
  during TypeDoc's normal validation step, #​3033.

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

v4.14.1

Compare Source

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.

v4.14.0

Compare Source

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 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](b)', '<b>' 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.

v4.13.1

Compare Source

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

v4.13.0

Compare Source

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

• fix signature parameters (#​874) - thanks @​Jym77.
• Symbol links without a declaration reference now print a warning and render as plain text instead of attempting to resolve to the nearest link (#​870).
• formatWithPrettier now resolves Prettier config against the file being written and reads .editorconfig, so path-specific settings are honoured (#​881).

v4.12.0

Compare Source

Minor Changes

• Support JSDoc-style <caption> labels for @example tags (#​861).
• Add Markdown theme translations for the fr locale.

Patch Changes

• Fixed duplicate sidebar groups when navigation.includeCategories=true and navigation.includeGroups=false (#​866).

v4.11.0

Compare Source

Minor Changes

• Improved rendering of union types when documented type details are present (#​857).
• Improved rendering of union types used in parameter declarations.
• When a function returns another function, full documentation for the returned function is now only shown when meaningful comments are present, aligning with the default theme.
• Index signature declarations are now rendered as blockquotes for improved consistency.

Patch Changes

• Added locale translations for grouped @example headings (#​858).
• Function-typed properties are now rendered without parentheses in headings. This avoids implying that the member is a method and more accurately reflects that it is a property whose type is a function.
• Optional properties are now indicated with ? in the property name, making the optionality explicit.
• All pipe characters (|) in union type output are now escaped.

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

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

v1.1.4

Compare Source

Patch Changes

• Declare typedoc as a peer dependency so it resolves from the package's own node_modules rather than the consumer's hoisting layout (#​891).

v1.1.3

Compare Source

Patch Changes

• Skip fenced code blocks in link-encoding regex (#​862) - thanks @​Kyujenius.

---

Configuration

📅 Schedule: (in timezone Europe/Copenhagen)

• Branch creation
  • "before 7am every weekday,every weekend"
• 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.

👻 Immortal: This PR will be recreated if closed unmerged. Get config help if that's undesired.

---

• If you want to rebase/retry this PR, check this box

---

This PR was generated by Mend Renovate. View the repository job log.