Skip to content

Releases: TypeStrong/typedoc

v0.23.19

28 Oct 03:05
Compare
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
Compare
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
Compare
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
Compare
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

v0.23.15

18 Sep 18:08
Compare
Choose a tag to compare

Features

  • TypeDoc will now treat @typedef {import("foo").Bar<Z>} Baz type declarations which forward type parameters to the imported
    symbol as re-exports of that symbol, #2044.

Bug Fixes

  • TypeDoc will now prefer comments on variable declarations over signature comments, #2042.
  • Fixed double rendering of "Type Parameters" header, #2054.
  • Fixed double rendering of "Hierarchy" header, #2053.
  • Removed unused widgets.png and [email protected] files from generated assets folder.

v0.23.14

03 Sep 12:18
Compare
Choose a tag to compare

Features

  • Added support for defining one-off external link mappings with externalSymbolLinkMappings see
    the documentation for usage examples and caveats, #2030.
  • External link resolvers defined with addUnknownSymbolResolver will now be checked when resolving @link tags, #2030.
    Note: To support this, resolution will now happen during conversion, and as such, Renderer.addUnknownSymbolResolver has been
    soft deprecated in favor of Converter.addUnknownSymbolResolver. Plugins should update to use the method on Converter.
    DefaultThemeRenderContext.attemptExternalResolution has also been deprecated since it will repeat work done during conversion,
    use ReferenceType.externalUrl instead.
  • Added Converter.addUnknownSymbolResolver for use by plugins supporting external links.

Bug Fixes

  • Fixed conversion of object literal types containing construct signatures, #2036.
  • Fixed centering of title bar on wide displays, actually this time, #2046.

v0.23.13

01 Sep 00:56
Compare
Choose a tag to compare

Bug Fixes

  • Fixed packages mode bug introduced in 0.23.12 (again), #2043.

v0.23.12

31 Aug 03:51
Compare
Choose a tag to compare

Features

  • Added a new ParameterType.Object for declaring object options which will be shallowly merged when read from user configuration.
  • Added a new Application.EVENT_BOOTSTRAP_END event emitted when Application.bootstrap is called.

Bug Fixes

  • TypeDoc will now work properly in packages mode when converting packages outside the current working directory, #2043.
  • Fixed deprecation warning for isIdentifierOrPrivateIdentifier.
  • Fixed centering of title bar on wide displays, #2046.

Thanks!

v0.23.11

26 Aug 03:56
Compare
Choose a tag to compare

Features

  • Added support for TypeScript 4.8.
  • Introduced a skipErrorChecking option which instructs TypeDoc to not ask TypeScript for compiler errors
    before attempting to generate documentation. Turning this on may improve generation speed, but could also
    cause a crash if your code contains compiler errors.
  • Added support for JS entry points when using packages mode, #2037.

Bug Fixes

  • Fixed crash when converting abstract mixin class, #2011.
  • Readme files within monorepos now have @link tags resolved, #2029.
  • Correctly resolve unqualified links to class members within parameters, #2031.
  • TypeDoc will now consider other reflections with the same name as parents when resolving links, #2033.
  • The "Hierarchy" and "Type Parameters" helpers on DefaultThemeRenderContext now contain all the HTML for their sections of the page, #2038.

Thanks!

v0.23.10

31 Jul 17:34
Compare
Choose a tag to compare

Features

  • Added support for detecting comments directly before parameters as the parameter comment, #2019.
  • Added support for using the comment directly before a constructor parameter that declares a property as the property comment, #2019.
  • Improved schema generation to give better autocomplete for the sort option.
  • Optional properties are now visually distinguished in the index/sidebar by rendering prop as prop?, #2023.
  • DefaultThemeRenderContext.markdown now also accepts a CommentDisplayPart[] for rendering, #2004.
  • Expose Converter.resolveLinks method for use with Converter.parseRawComment, #2004.

Bug Fixes

  • Fixed schema URL for TSDoc preventing the use of typedoc/tsdoc.json in TSDoc extends, #2015.
  • Improved detection of package names in repositories using pnpm, #2017.
  • Fixed missing JSDoc style @typedef comments for properties, #2020.

Thanks!