Skip to content

Releases: TypeStrong/typedoc

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!

v0.23.9

24 Jul 20:34
Compare
Choose a tag to compare

Bug Fixes

  • TypeDoc will no longer skip entry points which have no exports, #2007.
    If using "entryPointStrategy": "expand", this change may result in new pages being added to your documentation.
    If this is not desired, you can use the exclude option to filter them out.
  • Fixed missing comments on callable variable-functions constructed indirectly, #2008.
  • Packages mode will now respect the --includeVersion flag, #2010.
  • Fixed multiple reflections mapping to the same file name on case insensitive file systems, #2012.

v0.23.8

17 Jul 22:58
Compare
Choose a tag to compare

Features

  • Added defined in links for classes, enums, #180.
  • Added support for *.ghe.com and *.github.us GitHub enterprise domains for source links, #2001.
  • Expose Converter.parseRawComment for plugins to parse additional markdown files, #2004.

Bug Fixes

  • TypeDoc will no longer emit a warning for {@link} containing a URL, #1980.
  • excludeNotDocumented will no longer remove functions/methods/accessors which are documented, #1994.
  • Fixed missing sources property on signature reflections #1996.

Thanks!

v0.23.7

09 Jul 22:14
Compare
Choose a tag to compare

Bug Fixes

  • Tags must now contain whitespace after the tag name to be parsed as a tag, @jest/globals in a comment will no longer be parsed as a tag #1990.
  • The private member visibility option will now be respected in generated sites, #1992.
  • Overload rendering will no longer be broken if JavaScript is disabled, #453.
  • All overloads are now shown at once rather than requiring clicks to see the documentation for each signature, #1100.

v0.23.6

08 Jul 01:05
Compare
Choose a tag to compare

Features

  • Improved support for --entryPointStrategy Packages. TypeDoc will now load package-specific configurations from package.json typedoc field. This configuration allows configuring a custom display name (typedoc.displayName) field, entry point (typedoc.entryPoint - this is equivalent and will override typedocMain), and path to a readme file to be rendered at the top of the package page (typedoc.readmeFile), #1658.
  • The --includeVersion option will now be respected by --entryPointStrategy Packages. Also, for this combination, missing version field in the root package.json will not issue a warning.
  • The navigation partial will now call the new settings, primaryNavigation, and secondaryNavigation partials, #1987.

Bug Fixes

  • All warnings will be reported instead of only the first warning of a given type, #1981.
  • Include references will no longer be incorrectly parsed as links, #1986.
  • The generated schema.json on the website will now use enum values rather than enum names if possible.

Thanks!

v0.23.5

02 Jul 17:33
Compare
Choose a tag to compare

Features

  • The DEBUG_SEARCH_WEIGHTS global variable can now be set on window to add search scoring information in the search results.
  • TypeDoc's icons are now available on DefaultThemeRenderContext.icons for use/modification by themes.