Skip to content

Releases: TypeStrong/typedoc

v0.27.9

25 Feb 01:38
Compare
Choose a tag to compare

This will be the last v0.27.x release, see #2868 for discussion on the 0.28 beta.

Features

  • Added support for TypeScript 5.8

v0.28.0-beta.0

24 Feb 00:05
Compare
Choose a tag to compare
v0.28.0-beta.0 Pre-release
Pre-release

See #2868 for discussion of changes

v0.27.8

21 Feb 22:58
Compare
Choose a tag to compare

Features

  • The visibilityFilter option now supports individual signatures, #2846.
  • The favicon option may now be given a link starting with https?:// instead of a path, #2851.
  • TypeDoc now supports specifying # as the link in externalSymbolLinkMappings to indicate the type should not be linked to, #2853.

Bug Fixes

  • Fixed an issue where unrecognized languages would incorrectly be listed in the list of languages with translations, #2852.
  • Unresolved external type references will no longer incorrectly linked to undefined, #2854.

Thanks!

v0.27.7

09 Feb 19:35
Compare
Choose a tag to compare

Features

  • @includeCode and @inline can now inject parts of files using region
    names or line numbers, #2816.
  • Introduced ja translation options, deprecated jp in favor of ja, #2843.
  • Improved TypeDoc's --watch option to support watching files not caught by
    TypeScript's watch mode, #2675.
  • The @inline tag now works in more places for generic types.
  • Visibility filters now consider individual signatures, #2846.

Bug Fixes

  • Fixed an issue where TypeDoc would incorrectly ignore type arguments in references, #2823.
  • Improved narrator support for labeling icons, #2832.
  • Fixed an issue with @class incorrectly handling mapped types, #2842.
  • TypeDoc will now consider symbols to be external only if all of their declarations are external
    so that declaration merged members with global symbols can be documented, #2844.
  • Fixed an issue where TypeDoc would constantly rebuild, #2844.
  • Fixed an issue where the dropdown arrow in the index group would not respect the state of the dropdown, #2845.

Thanks!

v0.27.6

26 Dec 00:02
Compare
Choose a tag to compare

Features

  • Added ignoredHighlightLanguages option to specify languages which will be
    allowed in code blocks but not highlighted, #2819.

Bug Fixes

  • @include and @includeCode now work in the readme file, #2814.
  • TypeDoc will now avoid making references to references, #2811.
  • Fixed output specific option specification, #2818.
  • Improved type reference conversion to avoid including defaulted type arguments, #2820.
  • Fixed parsing of declaration references which include a module and a local reference, #2810.
  • Improved link resolution logic to prioritize type alias properties with the
    same symbol over type literal properties within function parameters.

v0.27.5

14 Dec 16:56
Compare
Choose a tag to compare

Bug Fixes

  • Possibly Breaking: TypeDoc will no longer render anchors within the page for
    deeply nested properties. This only affects links to properties of
    properties of types, which did not have a clickable link exposed so are
    unlikely to have been linked to. Furthermore, these links were not always
    created by TypeDoc, only being created if all parent properties contained
    comments, #2808.
  • TypeDoc will now warn if a property which does not have a URL within the
    rendered document and the parent property/page will be linked to instead,
    #2808. These warnings can be disabled with the validation.rewrittenLink
    option.
  • Fix restoration of groups/categories including documents, #2801.
  • Fixed missed relative paths within markdown link references in documents.
  • Improved handling of incomplete inline code blocks within markdown.
  • Direct https:// links under the hostedBaseUrl option's URL will no
    longer be treated as external, #2809.

Thanks!

v0.27.4

09 Dec 01:39
Compare
Choose a tag to compare

Features

  • API: Introduced new Converter.EVENT_CREATE_PROJECT event which fires when a project is created by the converter, #2800.

Bug Fixes

  • Switch from gzip to deflate for compressing assets to make output consistent across different operating systems, #2796.
  • @include and @includeCode now work for comments on the entry point for projects with a single entry point, #2800.
  • Cascaded modifier tags will no longer be copied into type literals, #2802.
  • @summary now works to describe functions within modules, #2803.
  • Corrected navigation showing module link as current when not on module page, #2805.

v0.27.3

04 Dec 05:51
Compare
Choose a tag to compare

Features

  • Added support for PNG favicons, #2790.
  • Improved support for hosting TypeDoc with strict Content Security Policy rules, #2794.

Bug Fixes

  • Add special handling for import types with type errors discarded with ts-expect-error, #2792.
  • Fixed low contrast in default colors for properties/accessors in light mode, #2795.
  • The highlightLanguages option now permits Shiki aliases to be specified rather than just the language ID, #2798.

Thanks!

v0.27.2

29 Nov 22:57
Compare
Choose a tag to compare

Bug Fixes

  • Fix crash with TypeScript 5.5.x, #2789.

v0.27.1

28 Nov 00:18
Compare
Choose a tag to compare

Bug Fixes

  • Include classes which inherit from another package in class hierarchy in packages mode, #2467.
  • Fixed handling of @categoryDescription and @groupDescription on module pages, #2787.
  • Fixed automatic discovery of entry points in packages mode.
  • Reverted accidental style change for hierarchy page introduced in 0.27.0
  • The hierarchy Expand/Collapse link will now only appear if the hierarchies are different.