Change Log

All notable changes to this project will be documented in this file. See Conventional Commits for commit guidelines.

3.14.0 (2022-12-02)

Features

Add objectLiteralTypeDeclarationStyle option (#362)
Beautify parameter table output of destructured params (#364)

Fixes

Fix missing descriptions for function params (#357)
Add conditional check to signature comments (#368)

3.13.6 (2022-09-04)

Fixes

Replace deprecated 'attemptExternalResolution' (#344)

3.13.5 (2022-08-30)

Fixes

Export media and includes options (#340)

3.13.4 (2022-07-20)

Fixes

Support @typeParam comments (#326)

3.13.3 (2022-07-05)

Fixes

Remove extraneous whitespace in tag description (#324)

3.13.2 (2022-06-30)

Fixes

Correctly display accessors in type declaration (#320)
Add new line after tags (#324)
Expose values to enums (#323)

3.13.1 (2022-06-28)

Note: Version bump only for package typedoc-plugin-markdown

3.13.0 (2022-06-27)

Features

TypeDoc 0.23 compatibility fixes (f39318e)

3.12.1 (2022-04-21)

Bug Fixes

Handle non-unique anchor ids (update) (#303) (2deb7b7)

3.12.0 (2022-04-09)

Bug Fixes

Handle non-unique anchor ids (#303) (787748f)

Features

Expose preserveAnchorCasing option (#301) (f51ff45)

3.11.14 (2022-02-14)

Bug Fixes

wrap index signature output within back ticks (#292) (2226322)

3.11.13 (2022-02-05)

Bug Fixes

Escape pipes in comments and expand object type in props table (#286) (b87c250)

3.11.12 (2022-01-18)

Bug Fixes

Fixed external resolution reference (#283) (ba935c9)

3.11.11 (2022-01-09)

Bug Fixes

Add comments for function type properties (#281) (d3441f2)

3.11.10 (2022-01-09)

Bug Fixes

Add comments for function type properties (#281) (c38a095)
Correctly define theme using TypeDoc defineTheme method (5f2ef42)

3.11.9 (2022-01-05)

Bug Fixes

Expose missing namedAnchors option (regression) (#277) (5353334)
Watch mode compatibility (#279) (da65f74)

3.11.8 (2021-12-17)

Bug Fixes

Fixed linked resolution (#274)

3.11.7 (2021-11-20)

Bug Fixes

Expand generic object (#268) (5029a85)

3.11.6 (2021-11-14)

Bug Fixes

Catch all external references (003cb96)
Fix type params with default values in params table (7d73eff)

3.11.5 (2021-11-12)

Bug Fixes

Expose 'includes' and 'media' options (regression) (#264) (435e0d2)

3.11.4 (2021-11-12)

Bug Fixes

Added support for third party symbols (#263) (e5a40d5)

3.11.3 (2021-10-05)

Bug Fixes

correctly render reference (#254) (32ce13a)

3.11.2 (2021-09-25)

Bug Fixes

Remove leading underscore from file names (#248) (bb5e4e3)

3.11.1 (2021-09-23)

Bug Fixes

Fix allReflectionsHaveOwnDocument option (64376e9)
Properly escape chars inside anchors (d4e5b1d)

3.11.0 (2021-09-14)

Features

TypeDoc 0.22 compatibility fixes (#249) (963250c)

3.10.4 (2021-07-20)

Bug Fixes

Fix anonymous function types in params table (0047faf)

3.10.3 (2021-07-12)

Bug Fixes

Handle TypeDoc 0.21.3 options breaking change (2d0e7b5)

3.10.2 (2021-06-24)

Bug Fixes

Fix string escape inside backticks (3b8ab18)

3.10.1 (2021-06-23)

Bug Fixes

Improve type params table readability (52038e2)
Use backticks for generics and refernce types to improve consistency (#239) (1b3395f)

3.10.0 (2021-06-18)

Features

TypeDoc 0.21 compatibility (fa5e913)

3.9.0 (2021-06-01)

Features

UI fixes and readability enhancements (#230) (f4329a9)

3.8.2 (2021-05-26)

Bug Fixes

Escape leading quote in front-matter string (#228) (ec38cbc)

3.8.1 (2021-05-11)

Bug Fixes

Escape double quotes inside Front Matter yaml string (8ce2f2b)
Fix duplicate source blocks (616ca4e)

3.8.0 (2021-05-05)

Bug Fixes

Add space between 'Const' and signature name (#220) (9400803)

Features

Enforce markdownlint standards (#219) (76a90bb)
Improve heading structure with disabled inline toc (#222) (2e898ac)

3.7.2 (2021-04-25)

Bug Fixes

Escape inherited types (#215) (34c5e7b)

3.7.1 (2021-04-18)

Bug Fixes

Remove extraneous whitespace in table description col (4e56ae4)

3.7.0 (2021-04-17)

Features

Prefix table bars to beggining of lines (064c0db)
Use backticks and quote strings for literal types (#212) (8949be1)

3.6.1 (2021-04-05)

Bug Fixes

Override section of methods overriding those of classes from node modules (cb74e83)

3.6.0 (2021-02-27)

Bug Fixes

Expand signature return types. (a348f53)

Features

Added --hidePageTitle option (0b9588b)
Added Front matter utils (a530828)

3.5.0 (2021-02-15)

Bug Fixes

Added missing class accessor labels (2b04924)
Include missing member type declarations (84f5703)
Remove emphasis inside angle brackets (20c9605)

Features

Conditionally display hierarchies (#192) (099351c)
Flatten nested params (#191) (9398d5c)
Left-align table headers (76012ab)

3.4.5 (2021-01-26)

Bug Fixes

Escape pipes properly (#187)

3.4.4 (2021-01-26)

Bug Fixes

Fixed navigation structure when readme=none