Sourced from typedoc's releases.

v0.27.4

Features

• API: Introduced new Converter.EVENT_CREATE_PROJECT event which fires when a project is created by the converter, #2800.

Bug Fixes

• Switch from gzip to deflate for compressing assets to make output consistent across different operating systems, #2796.
• @include and @includeCode now work for comments on the entry point for projects with a single entry point, #2800.
• Cascaded modifier tags will no longer be copied into type literals, #2802.
• @summary now works to describe functions within modules, #2803.
• Corrected navigation showing module link as current when not on module page, #2805.

v0.27.3

Features

• Added support for PNG favicons, #2790.
• Improved support for hosting TypeDoc with strict Content Security Policy rules, #2794.

Bug Fixes

• Add special handling for import types with type errors discarded with ts-expect-error, #2792.
• Fixed low contrast in default colors for properties/accessors in light mode, #2795.
• The highlightLanguages option now permits Shiki aliases to be specified rather than just the language ID, #2798.

Thanks!

• @​mikalai-snap
• @​mistic100

v0.27.2

Bug Fixes

• Fix crash with TypeScript 5.5.x, #2789.

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)

... (truncated)

Sourced from typedoc's changelog.

v0.27.4 (2024-12-09)

Features

• API: Introduced new Converter.EVENT_CREATE_PROJECT event which fires when a project is created by the converter, #2800.

Bug Fixes

• Switch from gzip to deflate for compressing assets to make output consistent across different operating systems, #2796.
• @include and @includeCode now work for comments on the entry point for projects with a single entry point, #2800.
• Cascaded modifier tags will no longer be copied into type literals, #2802.
• @summary now works to describe functions within modules, #2803.
• Corrected navigation showing module link as current when not on module page, #2805.

v0.27.3 (2024-12-04)

Features

• Added support for PNG favicons, #2790.
• Improved support for hosting TypeDoc with strict Content Security Policy rules, #2794.

Bug Fixes

• Add special handling for import types with type errors discarded with ts-expect-error, #2792.
• Fixed low contrast in default colors for properties/accessors in light mode, #2795.
• The highlightLanguages option now permits Shiki aliases to be specified rather than just the language ID, #2798.

Thanks!

• @​mikalai-snap
• @​mistic100

v0.27.2 (2024-11-29)

Bug Fixes

• Fix crash with TypeScript 5.5.x, #2789.

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)

... (truncated)

• 0879c5b Update changelog for release
• 6f2a480 Bump version to 0.27.4
• cf901f4 Fix current location check for index page
• 8680728 Exclude site plugin from linting
• 88b8f2b Add special case for rendering @summary for functions
• b35cfd2 Remove unnecessary test
• c3bc0da Reduce manually maintained duplication in generated site
• 344d4bf Handle @include tags on entry point project
• ed1ac7a Switch from gzip to deflate for compression
• 9dcbd5d Fix handling of cascadedModifierTags
• Additional commits viewable in compare view

Sourced from typedoc-plugin-markdown's releases.

typedoc-plugin-markdown@4.3.2

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

typedoc-plugin-markdown@4.3.1

Patch Changes

• Expose type declarations to array types.
• Correctly wrap array of unions in parenthesis (#719).
• Omit inline parameter declarations when not useful (#720).

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

Sourced from typedoc-plugin-markdown's changelog.

4.3.2 (2024-12-08)

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

4.3.1 (2024-12-01)

Patch Changes

• Expose type declarations to array types.
• Correctly wrap array of unions in parenthesis (#719).
• Omit inline parameter declarations when not useful (#720).

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.

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

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

• bfb1c60 Version Packages
• 43df8b1 chore(docs): updated typedoc option paths
• f39b42b fix(core): always expose type arguments of reference types as per default theme
• 27caafc chore(docs): updated packages
• ffaa2cd fix(core): enable @link resolution on type alias properties
• 05197cc fix(core): fixed spacing around inline object declarations
• 65ddaff fix(core): escape chars inside @link tags
• 11b5000 chore(all): updated packages
• b2db92c chore(docs): updated docs
• 2619301 chore(docs): updated docs
• Additional commits viewable in compare view

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)