Bump typedoc and typedoc-plugin-markdown

[dependabot]

Bumps typedoc and typedoc-plugin-markdown. These dependencies needed to be updated together.
Updates typedoc from 0.26.11 to 0.27.1

Release notes

Sourced from typedoc's releases.

v0.27.1

Bug Fixes

• Include classes which inherit from another package in class hierarchy in packages mode, #2467.
• Fixed handling of @categoryDescription and @groupDescription on module pages, #2787.
• Fixed automatic discovery of entry points in packages mode.
• Reverted accidental style change for hierarchy page introduced in 0.27.0
• The hierarchy Expand/Collapse link will now only appear if the hierarchies are different.

v0.27.0 (2024-11-27)

Breaking Changes

• Convert to ESM to enable easier use of ESM-only dependencies.
• Drop support for TypeScript <5.0, no longer supported by DefinitelyTyped
• Relaxed requirements for file names and generated url fragments. This may result in a different file name structure, #2714.
• Anchors to document headings and reflections within a HTML generated pages have changed. They can be partially restored to the previous format by setting --sluggerConfiguration.lowercase false. This change was made to more closely match the default behavior of GitHub's markdown rendering and VSCode's autocomplete when creating a relative link to an external markdown file.
• Removed the hideParameterTypesInTitle option, this was originally added as a workaround for many signatures overflowing the available horizontal space in rendered pages. TypeDoc now has logic to wrap types/signatures smartly, so this option is no longer necessary.
• Changed the default kindSortOrder to put references last.
• Changed the default sort order to use alphabetical-ignoring-documents instead of alphabetical.
• Changed default of suppressCommentWarningsInDeclarationFiles to true
• API: Constructor signatures now use the parent class name as their name (e.g. X, not new X)
• API: @group, @category, @groupDescription and @categoryDescription will no longer be removed from the reflections they are present on. They are skipped during rendering with the notRenderedTags option.

Features

• Add support for TypeScript 5.7
• TypeDoc will now discover entry points from package.json exports if they are not provided manually, #1937.
• Relative links to markdown files may now include #anchor links to reference a heading within them.
• Improved support for @param comments with nested object types, #2555.
• Improved support for @param comments which reference a type alias/interface. Important properties on the referenced type can now be highlighted with @param options.foo, which will result in the additional note being included under the documentation for that parameter, #2147. Note:

... (truncated)

Changelog

Sourced from typedoc's changelog.

v0.27.1 (2024-11-28)

Bug Fixes

• Include classes which inherit from another package in class hierarchy in packages mode, #2467.
• Fixed handling of @categoryDescription and @groupDescription on module pages, #2787.
• Fixed automatic discovery of entry points in packages mode.
• Reverted accidental style change for hierarchy page introduced in 0.27.0
• The hierarchy Expand/Collapse link will now only appear if the hierarchies are different.

v0.27.0 (2024-11-27)

Breaking Changes

• Convert to ESM to enable easier use of ESM-only dependencies.
• Drop support for TypeScript <5.0, no longer supported by DefinitelyTyped
• Relaxed requirements for file names and generated url fragments. This may result in a different file name structure, #2714.
• Anchors to document headings and reflections within a HTML generated pages have changed. They can be partially restored to the previous format by setting --sluggerConfiguration.lowercase false. This change was made to more closely match the default behavior of GitHub's markdown rendering and VSCode's autocomplete when creating a relative link to an external markdown file.
• Removed the hideParameterTypesInTitle option, this was originally added as a workaround for many signatures overflowing the available horizontal space in rendered pages. TypeDoc now has logic to wrap types/signatures smartly, so this option is no longer necessary.
• Changed the default kindSortOrder to put references last.
• Changed the default sort order to use alphabetical-ignoring-documents instead of alphabetical.
• Changed default of suppressCommentWarningsInDeclarationFiles to true
• API: Constructor signatures now use the parent class name as their name (e.g. X, not new X)
• API: @group, @category, @groupDescription and @categoryDescription will no longer be removed from the reflections they are present on. They are skipped during rendering with the notRenderedTags option.

Features

• Add support for TypeScript 5.7
• TypeDoc will now discover entry points from package.json exports if they are not provided manually, #1937.
• Relative links to markdown files may now include #anchor links to reference a heading within them.
• Improved support for @param comments with nested object types, #2555.
• Improved support for @param comments which reference a type alias/interface. Important properties on the referenced type can now be highlighted with @param options.foo, which will result in the additional note being included under the documentation for that parameter, #2147. Note:

... (truncated)

Commits

• 6142a5e Update changelog for release
• 1ce36a4 Bump version to 0.27.1
• fa2a322 Include classes from other packages in class hierarchy
• 5d279c3 Minor hierarchy quality of life improvements
• c2c1289 Fix @categoryDescription, @groupDescription on modules
• 72b4054 Update @includeCode example
• 110b081 Correct documentation for jsDocCompatibility
• 51dcb74 Add @include and @includeCode to changelog for 0.27
• 6adc8c6 Fix automatic entry point discovery for packages
• 6868398 Fix broken links on plugin page
• Additional commits viewable in compare view

Updates typedoc-plugin-markdown from 4.2.10 to 4.3.0

Release notes

Sourced from typedoc-plugin-markdown's releases.

typedoc-plugin-markdown@4.3.0

Minor Changes

• Implemented typedoc 0.27 compatibility support.
• 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).
• Exposed formatting with prettier options "formatWithPrettier" and "prettierConfigFile" that enables additional formatting of output if Prettier is installed on a project.

Patch Changes

• Improved structure of curried and overloaded signatures (#714) (#718)
• The "hideGroupHeadings" option respects group order (#716)
• Handle Optional types correctly (#719).

Changelog

Sourced from typedoc-plugin-markdown's changelog.

4.3.0 (2024-11-27)

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

Commits

• 19c21a3 Version Packages
• fbfd19b chore(all): final output tweaks
• 5e95bba chore(core): updated docs
• e2a3467 feat(core): exposed formatting with prettier options
• a667e80 chore(all): updated typedoc
• b323a8a feat(core): improve parameter and type declaration listings
• 1d33b64 fix(core): handle optional types correctly
• a0e2ff9 fix(core): updated default output as per updated api
• 142ced6 fix(core): tweaked signature overloads
• e59d55c fix(core): fix comments and clarify headings for overload and curried methods...
• Additional commits viewable in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

---

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

• @dependabot rebase will rebase this PR
• @dependabot recreate will recreate this PR, overwriting any edits that have been made to it
• @dependabot merge will merge this PR after your CI passes on it
• @dependabot squash and merge will squash and merge this PR after your CI passes on it
• @dependabot cancel merge will cancel a previously requested merge and block automerging
• @dependabot reopen will reopen this PR if it is closed
• @dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
• @dependabot show <dependency name> ignore conditions will show all of the ignore conditions of the specified dependency
• @dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
• @dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
• @dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

[dependabot]

Superseded by #5143.