Skip to content

Releases: TypeStrong/typedoc

v0.23.25

11 Feb 16:31

Choose a tag to compare

Breaking Changes

  • Upgraded Shiki, if your highlight theme was set to material-<theme>, the value will need to be changed to
    material-theme-<theme>, see the Shiki release notes.

Features

  • Added new excludeNotDocumentedKinds variable to control which reflection types can be removed
    by the excludeNotDocumented option, #2162.
  • Added typedoc.jsonc, typedoc.config.js, typedoc.config.cjs, typedoc.cjs to the list of files
    which TypeDoc will automatically use as configuration files.

Bug Fixes

  • Entry points under node_modules will no longer be ignored, #2151.
  • Corrected behavior of excludeNotDocumented on arrow function-variables, #2156.
  • Added package.json to exports declaration.

Thanks!

v0.23.24

07 Jan 19:37

Choose a tag to compare

Bug Fixes

  • Fixed an issue where signature comments were preferred over property comments for indirectly created function-properties, #2135.
  • Fixed symlink handling when expanding entry points, #2130.

Thanks!

v0.23.23

18 Dec 04:12

Choose a tag to compare

Features

  • Added ts.Signature to emitted EVENT_CREATE_SIGNATURE event, #2002.

Bug Fixes

  • Links to members hidden by filter settings now temporarily override the filter, #2092.
  • If src/ and src/x are specified as entry points, src/ will no longer be ignored, #2121.

v0.23.22

11 Dec 15:56

Choose a tag to compare

Features

  • Add support for defining the kind sort order, #2109.

Bug Fixes

  • Normalize all file paths on Windows, #2113.
  • Fix @link tags within lists, #2103.

v0.23.21

14 Nov 00:11

Choose a tag to compare

Features

  • Added support for a catch-all wildcard in externalSymbolLinkMappings, #2102.
  • Added support for TypeScript 4.9.

Thanks!

v0.23.20

03 Nov 03:11

Choose a tag to compare

Bug Fixes

  • Fixed comment discovery for @inheritDoc if inheriting from a function type alias, #2087.

v0.23.19

28 Oct 03:05

Choose a tag to compare

Bug Fixes

  • Fixed title link if titleLink option was not specified, #2085.

Thanks!

v0.23.18

23 Oct 20:14

Choose a tag to compare

Features

  • Improved error reporting when failing to find entry points, #2080, #2082.

Bug Fixes

  • Constructor parameter-properties will now use the @param comment for the parameter if available, #1261.
  • Fixed display of object types containing methods, #1788.
  • Fixed conversion of intrinsic string mapping types when converting without a type node, #2079.

v0.23.17

18 Oct 02:08

Choose a tag to compare

Features

  • Added titleLink, navigationLinks and sidebarLinks options to add additional links to the rendered output, #1830.
  • Added sourceLinkTemplate option to allow more flexible specification of remote urls.
    Deprecated now redundant gitRevision detection starting with https?:// introduced in v0.23.16, #2068.

Thanks!

v0.23.16

10 Oct 21:15

Choose a tag to compare

Features

  • Object types will now be pretty printed, #1793.
  • Added support for specifying the tsconfig.json file in packages mode with { "typedoc": { "tsconfig": "tsconfig.lib.json" }} in package.json, #2061.
  • In packages mode, readme files will now be automatically included if present, #2065.
  • Added support for specifying the base file url for links to source code, #2068.

Bug Fixes

  • Private parameter properties will no longer be ignored, #2064.

Thanks!

  • @captainTorch