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 forTypeDoc 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'srouter 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 toparametersFormat=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).