Bug Fixes

• Fixed an issue causing TypeDoc to fail to generate documentation when implementing interfaces, #3052.
• Fixed an issue preventing automatic entry point discovery on Windows, #3057.
• Improved vertical positioning of text icons, #3056.
• TypeDoc no longer includes source location information for type literal reflections. This could sometimes
  cause TypeDoc to infer the wrong path when resolving base paths for display.
• Adjusted markdown rendering to allow markdownItLoader to override more rendering #3055.

Features

• Added support for regions for @include in .tsx, .cjs, and .mjs file references #3048.
• Comments for TS-in-JS @typedef tags may now specify modifier tags with the inline tag syntax {@mod}.
  This makes it possible to add modifier tags to these members, which previously was not possible as
  TypeScript's parsing stops for these members at the next non-braced tag, #2916 and #3050.
• A typedoc-config.schema.json is now included in the root of the package with a JSON schema for TypeDoc's
  configuration file. The schema for the latest version is also published at https://typedoc.org/schema.json
  and will automatically be picked up when writing typedoc.json files if you are using VSCode, #3054.

Thanks!

• @a10nik
• @kozi
• @Lakuna

Features

• The gitRevision option now accepts the special value {branch}, which indicates source links should use
  the current git branch for links, #3041.
• Introduced validation.invalidPath for suppressing warnings caused by referencing relative paths which
  do not exist when building the documentation, #3033.
• API: Introduced Logger.validationWarning for validation which occurs during conversion rather than
  during TypeDoc's normal validation step, #3033.

Features

• Introduced the preservedTypeAnnotationTags option to specify tags whose type annotations should
  be copied to the output documentation, #3020.
  API: Introduced typeAnnotation on CommentTag
• Added excludePrivateClassFields option to hide #private members while allowing private members, #3017.
• Added support for TypeScript's @this tag for JS files which describe this parameters, #3026.

Bug Fixes

• Fixed conversion of auto-accessor types on properties with the accessor keyword, #3019.
• Improved handling of HTML tags within headers for anchor generation, #3023.
• Improved support for detecting destructured parameters and renaming them to the name used in the doc comment, #3026.

Features

• The basePath option now also affects relative link resolution, TypeDoc will also check for
  paths relative to the provided base path. If you instead want TypeDoc to only change the rendered
  base path for sources, use the displayBasePath option, #3009.

Bug Fixes

• Fixed bug introduced in 0.28.8 where TypeDoc could not render docs with some mixin classes, #3007.
• @inheritDoc will now correctly overwrite @remarks and @returns blocks on the target comment, #3012.
• The externalSymbolLinkMappings option now works properly on links pointing to inherited/overwritten signatures, #3014.

Bug Fixes

• Variables marked with @enum now work for symbols imported from another module, #3003.
• Improved magic introduced with #2999 to work with imported symbols, #3003.
• Fixed relative link resolution to file names containing percent encoded URLs, #3006.
• Linking to the project's README file with a relative link will now behave as expected, #3006.
• Reduced unnecessary HTML element rendering in default theme.
  API: Reflection.hasComment and Comment.hasVisibleComponent now accepts an optional notRenderedTags parameter.

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.

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.

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.

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!

• @jonathanhefner
• @laymonage

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.