v0.28.16

Compare Source

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

v0.28.15

Compare Source

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.

v0.28.14

Compare Source

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.

v0.28.13

Compare Source

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.

v0.28.12

Compare Source

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.

v0.28.11

Compare Source

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

Compare Source

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

Compare Source

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

Compare Source

Features

• If using JS config files, the plugin function 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

v0.28.7

Compare Source

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

Compare Source

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!

• @​yGuy

v0.28.5

Compare Source

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

Compare Source

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!

• @​blutorange
• @​bkeepers

v0.28.3

Compare Source

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

Compare Source

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.

v0.28.1

Compare Source

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.

v0.28.0

Compare Source

Breaking Changes

• TypeDoc now expects all input globs paths to be specified with / path separators, #​2825.
• TypeDoc's --entryPointStrategy merge mode now requires JSON from at least version 0.28.0.
• Removed jp translations from lang, to migrate switch to ja.
• File name references in intentionallyNotExported now use a package name/package relative path instead of an absolute path for matching.
• The source-order sort ordering now considers package names / package relative paths instead of using the absolute paths to a file.
• TypeDoc will only check for a project README file next to the discovered package.json file if --readme is not set
  this change improves handling of monorepo setups where some packages have readme files and others do not, #​2875.
• Function-like variable exports will now only be automatically converted as function types if
  they are initialized with a function expression. TypeDoc can be instructed to convert them as functions
  with the @function tag, #​2881.
• Object literal type alias types will now be converted in a way which causes them to be rendered more similarly
  to how interfaces are rendered, #​2817.

API Breaking Changes

• ProjectReflection.getReflectionFromSymbol and ProjectReflection.getSymbolFromReflection have been moved to Context
• Path and PathArray parameter types now always contain normalized paths.
• Introduced a Router which is used for URL creation. Reflection.url,
  Reflection.anchor, and Reflection.hasOwnDocument have been removed.
• Deserializer.reviveProject(s) no longer accepts an option to add project documents.
• Deserializer.reviveProjects now requires an alwaysCreateEntryPointModule option.
• Comment.serializeDisplayParts no longer requires a serializer argument.
• ReflectionSymbolId.fileName is now optional, TypeDoc now stores a combination of a package name and package relative path instead.
  The fileName property will be present when initially created, but is not serialized.
• Removed DeclarationReflection.relevanceBoost attribute which was added for plugins, but never used.
• i18n proxy is no longer passed to many functions, instead, reference i18n exported from the module directly.
• ReflectionKind.singularString and ReflectionKind.pluralString now returns translated strings.
  The methods on Internationalization to do this previously have been removed.
• The HTML output structure for the search box has changed to support the new modal.
• DefaultThemeRenderContext's typeDeclaration and typeDetailsIfUseful
  methods now require both a reflection and a type in order to support
  @expandType

Features

• Add support for TypeScript 5.8.x
• The search modal in the HTML output has been rewritten to provide better mobile support
• Added a --router option which can be used to modify TypeDoc's output folder
  structure. This can be extended with plugins, #​2111.
• Introduced the @primaryExport modifier tag to provide more fine grained
  control over export conversion order, #​2856
• Introduced packagesRequiringDocumentation option for validation.notDocumented, TypeDoc will expect comments to be present for symbols in the specified packages.
• TypeDoc now exports a typedoc/browser entrypoint for parsing and using serialized JSON files, #​2528.
• Type packageOptions as Partial<TypeDocOptions>, #​2878.
• TypeDoc will now warn if an option which should only be set at the root level is set in packageOptions, #​2878.
• Introduced @function tag to force TypeDoc to convert variable declarations with a type annotation as functions, #​2881.
• Exposed a TypeDoc global object in the HTML theme which can be used to prevent TypeDoc from using localStorage, #​2872.
• Introduced @preventInline and @inlineType tags for further control extending the @inline tag, #​2862.
• Introduced @preventExpand and @expandType tags for further control extending the @expand tag, #​2862.
• API: Introduced DefaultThemeRenderContext.reflectionIcon for more granular control over displayed reflection icons.

Bug Fixes

• TypeDoc will now only create references for symbols re-exported from modules.
• Variable-functions will now prefer placing the comment on the signature if there is only one signature present, #​2824.
• User filter settings will no longer sometimes cause the search to have fewer visible results than expected.
• Fixed handling of expando functions which were also merged with a namespace, #​2876.
• Fixed rendering of function types within arrays and union types, #​2892.
• Fixed an issue where if the theme JS didn't load, the page wouldn't be shown, #​2894.

Thanks!

• @​crimx
• @​jsmith2-coveo
• @​phoneticallySAARTHaK
• @​XeroAlpha

v0.27.9

Compare Source

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.27.8

Compare Source

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!

• @​pjeby
• @​XeroAlpha

v0.27.7

Compare Source

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!

• @​pjeby
• @​shawninder
• @​tats-u
• @​XeroAlpha

v0.27.6

Compare Source

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

Compare Source

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!

• @​SacDeNoeuds

v0.27.4

Compare Source

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

Compare Source

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!

• @​mikalai-snap
• @​mistic100

v0.27.2

Compare Source

Bug Fixes

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

v0.27.1

Compare Source

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.