Documentation generator for TypeScript projects.
--sourceLinkExternal option to render source code links as external, #2415.declarationMap option to be set to true to handle cross-package links in packages mode, #2416.external-last option for the --sort option, #2418.navigationLeaves option to remove branches from the navigation tree, #2382.sortEntryPoints option (defaults to true) to allow disabling entry point sorting, #2393.@template constraints on JSDoc defined type parameters, #2389.declare module "foo", #2401.stripYamlFrontmatter config option to remove YAML frontmatter from README.md, #2381.--excludeCategories config option to remove reflections present in any excluded category, #1407.DefaultTheme.buildNavigation
to customize the displayed navigation tree, #2287.
Note: This change renders navigation.fullTree obsolete. If you set it, TypeDoc will warn that it is being ignored.
It will be removed in v0.26.DefaultThemeRenderContext.icons is overwritten by a custom theme.
Note: To perform this optimization, TypeDoc relies on DefaultThemeRenderContext.iconCache being rendered within
each page. TypeDoc does it in the defaultLayout template.@property now works as expected if used to override a method's documentation.--watch mode works again, #2378.intrinsic keyword if TS intrinsic types are included in documentation.--exclude is now respected when expanding globs in entry points, #2376.legacy-packages option for --entryPointStrategy.--categorizeByGroup to false.gitRemote is no longer supported.Application instance must now be retrieved via Application.bootstrap or Application.bootstrapWithPlugins, #2268.ReflectionKind.ObjectLiteral that was never used by TypeDoc.DefaultThemeRenderContext.comment and DefaultThemeRenderContext.attemptExternalResolution.--preserveLinkText option (defaults to true) which determines whether the reflection name or full link text is included
in the output when no override is specified, #2355.--disableGit option to prevent TypeDoc from using Git to try to determine if sources can be linked, #2326.@showGroups, @hideGroups, @showCategories, @hideCategories to configure the navigation pane on a
per-reflection basis, #2329.--jsDocCompatibility.defaultTags set, @defaultValue is now implicitly a code block if the text contains no code, #2370.Foo#bar) links were used and --useTsLinkResolution is enabled in some cases, #2360.@inheritDoc was not properly resolved across packages in packages mode, #2331.@interface use on union types, #2352.Theme.getUrls, #2318.@namespace is used on a variable with an associated namespace, #2364.@namespace property discovery if merged with a type and the type was declared first #2364.reflection.sources now considers the node's name like non-signature location discovery does.navigation.fullTree to control rendering the full navigation tree on each page, #2287.
This option will likely be replaced in 0.25 with dynamic loading of the full tree.--pretty option now also controls whether generated HTML contains line breaks, #2287.MarkdownEvent.INCLUDE for plugins, #2284.sort option, #2272.g, circle, ellipse, polygon, and polyline svg elements, #2259.jsDocCompatibility option with inheritDocTag to ignore fully lowercase inheritDoc tags and
ignoreUnescapedBraces to disable warnings about unescaped { and } characters in comments.--useTsLinkResolution is no longer ignored within block tags, #2260.--navigation.includeCategories
and --navigation.includeGroups to control this behavior. The --categorizeByGroup option also
effects this behavior. If categorizeByGroup is set (the default) and navigation.includeGroups is
not set, the value of navigation.includeCategories will be effectively ignored since categories
will be created only within groups, #1532.@returns blocks will now be rendered with the return type, #2180.--groupOrder option to specify the sort order of groups, #2251.--hideParameterTypesInTitle option, #2226.@returns block is is present in a function, and ignore the duplicate blocks as specified by TSDoc.