Skip to content

Releases: typedoc2md/typedoc-plugin-markdown

typedoc-plugin-markdown@4.13.0

Choose a tag to compare

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

typedoc-plugin-markdown@4.12.0

Choose a tag to compare

@tgreyuk tgreyuk released this 02 Jun 15:03
2d00ffb

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

typedoc-plugin-markdown@4.11.0

Choose a tag to compare

@github-actions github-actions released this 18 Mar 22:45
a9333a5

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.

typedoc-plugin-markdown@4.10.0

Choose a tag to compare

@github-actions github-actions released this 06 Feb 17:57
37069c3

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

typedoc-plugin-markdown@4.9.0

Choose a tag to compare

@github-actions github-actions released this 19 Sep 21:59
9bb0c61

Minor Changes

  • Exposed new option navigationJson that can be used to write navigation structure as JSON to disk.

Patch Changes

  • Remove type params from inline reflection titles when router=module to resolve anchoring issues (#843).

typedoc-plugin-markdown@4.8.1

Choose a tag to compare

@github-actions github-actions released this 11 Aug 22:56
c1eea81

Patch Changes

  • Correctly handle empty markdown links (#836).

typedoc-plugin-markdown@4.8.0

Choose a tag to compare

@tgreyuk tgreyuk released this 29 Jul 22:42
f44b2d9

Minor Changes

  • Exposed additional placeholders in pageTitleTemplates and adjusted default templates ([#831]).
  • Tweaked the format of abstract class page titles to include the translated abstract keyword (e.g., "Abstract Class: MyClass") for improved readability.
  • Added strikeDeprecatedPageTitles option.

Patch Changes

  • Fix incorrect link fragments (#832).

typedoc-plugin-markdown@4.7.1

Choose a tag to compare

@tgreyuk tgreyuk released this 19 Jul 20:21
a72af31

Patch Changes

  • Escape square brackets in index signature types (#829).
  • Fix missing segments in declaration titles that contain periods.

typedoc-plugin-markdown@4.7.0

Choose a tag to compare

@github-actions github-actions released this 20 Jun 07:21
5081ddf

Minor Changes

  • Added useCustomAnchors and customAnchorsFormat options - thanks @ocavue.

Patch Changes

  • Fix incorrect overload function comments (#827).

typedoc-plugin-markdown@4.6.4

Choose a tag to compare

@github-actions github-actions released this 01 Jun 11:27
c050212

Patch Changes

  • Added theme translations for "de" locale.
  • Fix navigation items without group or categories (@group/@category=none) (#815).
  • Correctly handle sidebar groups for packages with merged modules.