Skip to content

Releases: typedoc2md/typedoc-plugin-markdown

typedoc-plugin-markdown@4.10.0

06 Feb 17:57
37069c3

Choose a tag to compare

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

19 Sep 21:59
9bb0c61

Choose a tag to compare

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

11 Aug 22:56
c1eea81

Choose a tag to compare

Patch Changes

  • Correctly handle empty markdown links (#836).

typedoc-plugin-markdown@4.8.0

29 Jul 22:42
f44b2d9

Choose a tag to compare

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

19 Jul 20:21
a72af31

Choose a tag to compare

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

20 Jun 07:21
5081ddf

Choose a tag to compare

Minor Changes

  • Added useCustomAnchors and customAnchorsFormat options - thanks @ocavue.

Patch Changes

  • Fix incorrect overload function comments (#827).

typedoc-plugin-markdown@4.6.4

01 Jun 11:27
c050212

Choose a tag to compare

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.

typedoc-plugin-markdown@4.6.3

23 Apr 10:57
fed1166

Choose a tag to compare

Patch Changes

  • Correctly handle group title in pageTitleTemplates callback (#807).
  • Format of optional type and getter/setter (#804) - thanks @normanzb.

typedoc-plugin-markdown@4.6.2

09 Apr 16:30
64da790

Choose a tag to compare

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.

typedoc-plugin-markdown@4.6.1

02 Apr 08:59
6d7b357

Choose a tag to compare

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.