Skip to content

Releases: TypeStrong/typedoc

v0.28.11

25 Aug 03:13
Compare
Choose a tag to compare

Features

  • Object properties declared with shorthand property assignment will now use the variable's comment
    if they do not have their own comment, #2999.

Bug Fixes

  • Fixed link resolution not working correctly in first comment on the file in some cases, #2994.
  • Optional methods are now rendered with a trailing ? in the reflection preview and signature, #2995.
  • The compilerOptions option now functions properly with non-boolean options, #3000.
  • Configuration errors within the compilerOptions option are now handled gracefully, #3000.
  • Fixed improper casing of "Type Declaration" header, #3002.

v0.28.10

10 Aug 18:14
Compare
Choose a tag to compare

Bug Fixes

  • Fixed inconsistent anchors on module pages for re-exports, #2990.
  • Markdown references which appear to be footnotes will no longer be checked for links, #2991.

v0.28.9

01 Aug 15:56
Compare
Choose a tag to compare

Features

  • Add support for TypeScript 5.9, #2989.

Bug Fixes

  • Fixed bug introduced in 0.28.8 where TypeDoc could not render docs when members inherited from a complex type alias, #2982.
  • Fixed automatic discovery of entry points when not running in packages mode, #2988.
  • Fixed discovery of package.json file when running with entry points containing a glob, #2985.

v0.28.8

28 Jul 01:55
Compare
Choose a tag to compare

Features

  • If using JS config files, the plugin option can now be given plugin functions to load.
  • Permit - within tag names to support typescript-json-schema's @TJS-type tag, #2972.
  • Exposed Context.createSymbolId for use by plugins.

Bug Fixes

  • Relative links in <img srcset> will now be discovered by TypeDoc, #2975.
  • Relative links in <source src> and <source srcset> elements will now be discovered by TypeDoc, #2975.
  • Improved inherited from/overwrites link discovery to point to parent properties in more cases, #2978

Thanks!

v0.28.7

30 Jun 02:22
Compare
Choose a tag to compare

Features

  • Introduced the @sortStrategy tag to override the sort option on a specific reflection, #2965.

Bug Fixes

  • Classes and functions exported with export { type X } are no longer missing comments, #2970.
  • Setting locale to an unknown value will now cause TypeDoc to operate in English instead of a debug locale.
  • Array options will now report an error if set to a non-array/non-string value.

v0.28.6

27 Jun 03:49
Compare
Choose a tag to compare

Features

  • TypeDoc now supports resolving relative paths in links to the package directory as belonging to the project, #2961.
  • Declarations without comments will now check for comments on their export specifier, #2964.

Bug Fixes

  • Attempting to highlight a supported language which is not enabled is now a warning, not an error, #2956.
  • Improved compatibility with CommonMark's link parsing, #2959.
  • Classes, variables, and functions exported with export { type X } are now detected and converted as interfaces/type aliases, #2962.
  • Improved warning messaging for links to symbols which were resolved, but the symbols were not included in the documentation, #2967.
  • Fixed an issue preventing nested documents from being deserialized from TypeDoc's JSON output or used in packages mode, #2969.

Thanks!

v0.28.5

26 May 15:01
Compare
Choose a tag to compare

Bug Fixes

  • References to type aliases defined as mapped types will now correctly create a reference to the type alias, #2954.
  • ignoredHighlightLanguages can now be used to prevent warnings for codeblocks containing languages
    which are supported by Shiki but are not loaded, #2956.

v0.28.4

04 May 00:25
Compare
Choose a tag to compare

Features

  • The navigation in the default theme will now attempt to break long names onto multiple lines, #2940.
  • Added German (de) localization, #2941.

Bug Fixes

  • TypeDoc's default theme now uses the same chevron for all collapsible elements, #2924
    The chevronSmall helper is now deprecated and will be removed with v0.29.0.
  • Classes/interfaces marked with @hidden will no longer appear in the
    "Hierarchy" section of the docs.
  • TypeDoc now handles wildcard JSDoc types, #2949.

Thanks!

v0.28.3

20 Apr 01:25
Compare
Choose a tag to compare

Bug Fixes

  • @inline now functions when referencing tuple types, #2932.
  • @link links to the current page are now rendered, #2934.
  • @includeCode now supports regions in TypeScript files with .mts and .cts file extensions, #2935.
  • Aliased symbols (re-exports) are now resolved before checking if they are excluded/external, #2937.
  • Improved error reporting when paths including Windows separators are provided as globs, #2938.

v0.28.2

07 Apr 01:46
Compare
Choose a tag to compare

Features

  • @group none and @category none will now render their children without a section
    heading in the default theme, #2922.
  • Added @disableGroups tag to completely disable the grouping mechanism for a
    given reflection, #2922.

Bug Fixes

  • Variables using @class now correctly handle @category, #2914.
  • Variables using @class now include constructor parameters, #2914.
  • Variables using @class with a generic first constructor function now adopt
    that function's type parameters as the class type parameters, #2914.
  • When printing entry point globs which fail to match any paths, TypeDoc will no longer normalize the glob, #2918.
  • Inlining types can now handle more type variants, #2920.
  • Fixed behavior of externalSymbolLinkMappings option when URL is set to #, #2921.
  • Fixed broken links within module pages when structure-dir router was used, #2928.
  • Type parameters on JS classes defined with @typedef now correctly handle the constraint, #2929.
  • API: toString on types containing index signatures now behave correctly, #2917.
  • Added @inlineType to the list of tags excluded by default.