Releases: TypeStrong/typedoc
Releases Β· TypeStrong/typedoc
v0.25.1
Features
- Added
stripYamlFrontmatter
config option to remove YAML frontmatter from README.md, #2381. - Added
--excludeCategories
config option to remove reflections present in any excluded category, #1407. - If no tsconfig.json file is present, TypeDoc will now attempt to compile without setting any compiler options, #2304.
- Navigation is now written to a JS file and built dynamically, which significantly decreases document generation time
with large projects and also provides large space benefits. Themes may now overrideDefaultTheme.buildNavigation
to customize the displayed navigation tree, #2287.
Note: This change rendersnavigation.fullTree
obsolete. If you set it, TypeDoc will warn that it is being ignored.
It will be removed in v0.26. - The search index is now compressed before writing, which reduces most search index sizes by ~5-10x.
- TypeDoc will now attempt to cache icons when
DefaultThemeRenderContext.icons
is overwritten by a custom theme.
Note: To perform this optimization, TypeDoc relies onDefaultThemeRenderContext.iconCache
being rendered within
each page. TypeDoc does it in thedefaultLayout
template. - Cache URL derivation during generation, #2386.
Bug Fixes
@property
now works as expected if used to override a method's documentation.- Deprecated functions/methods are now correctly rendered with a struck-out name.
--watch
mode works again, #2378.- Improved support for optional names within JSDoc types, #2384.
- Fixed duplicate rendering of reflection flags on signature parameters, #2385.
- TypeDoc now handles the
intrinsic
keyword if TS intrinsic types are included in documentation. --exclude
is now respected when expanding globs in entry points, #2376.
Thanks!
v0.25.0
Breaking Changes
- Bump minimum Node version to 16.
- Removed
legacy-packages
option for--entryPointStrategy
. - Changed default value of
--categorizeByGroup
tofalse
. - Specifying a link as the
gitRemote
is no longer supported. - An
Application
instance must now be retrieved viaApplication.bootstrap
orApplication.bootstrapWithPlugins
, #2268. - Removed
ReflectionKind.ObjectLiteral
that was never used by TypeDoc. - Removed deprecated members
DefaultThemeRenderContext.comment
andDefaultThemeRenderContext.attemptExternalResolution
.
Features
- Added support for TypeScript 5.2
- TypeDoc config files now support options default-exported from an ESM config file, #2268.
- TypeDoc config files may now export a promise containing configuration, #2268.
- Added
--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. - Added a no-results placeholder when no search results are available, #2347.
- Implemented several miscellaneous performance improvements to generate docs faster, this took the time to generate TypeDoc's
site from ~5.6 seconds to ~5.4 seconds. - Added
--disableGit
option to prevent TypeDoc from using Git to try to determine if sources can be linked, #2326. - Added support for tags
@showGroups
,@hideGroups
,@showCategories
,@hideCategories
to configure the navigation pane on a
per-reflection basis, #2329. - With
--jsDocCompatibility.defaultTags
set,@defaultValue
is now implicitly a code block if the text contains no code, #2370.
Bug Fixes
- Fixed link discovery if nested (
Foo#bar
) links were used and--useTsLinkResolution
is enabled in some cases, #2360. - Links with invalid declaration references will no longer silently link to the wrong page in some cases, #2360.
- Fixed duplicate definitions in type hierarchy when using packages mode, #2327.
@inheritDoc
was not properly resolved across packages in packages mode, #2331.- Added warning for attempted
@interface
use on union types, #2352. - Fixed misleading type annotation on
Theme.getUrls
, #2318. - Fixed duplicate namespace in documentation if
@namespace
is used on a variable with an associated namespace, #2364. - Fixed
@namespace
property discovery if merged with a type and the type was declared first #2364. - Tables in markdown are now styled, #2366.
- Sidebar links no longer open in a new tab, #2353.
- Headers now include some padding before rendering text, #2316.
- Symbol locations for signatures on
reflection.sources
now considers the node's name like non-signature location discovery does.
Thanks!
v0.24.8
Features
- Added support for TypeScript 5.1, #2296.
- Added
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. - TypeDoc's
--pretty
option now also controls whether generated HTML contains line breaks, #2287. - Optimized icon caching to reduce file size in generated HTML documentation, #2287.
- Render property description of "roughly top level" object types, #2276.
- Added
MarkdownEvent.INCLUDE
for plugins, #2284.
Bug Fixes
- When rendering functions/methods, TypeDoc will now render the comment summary above the parameters/return type,
and any other block tags in the order they are defined in the comment, #2285. - Comments are no longer removed from classes/interfaces containing call signatures, #2290.
Thanks!
v0.24.7
Features
- TypeDoc will now allow conversion without any entry points to support "readme only" packages, #2264.
Bug Fixes
v0.24.6
Features
- Improved error messaging if a provided entry point could not be converted into a documented module reflection, #2242.
- API: Added support for
g
,circle
,ellipse
,polygon
, andpolyline
svg elements, #2259. - Extended
jsDocCompatibility
option withinheritDocTag
to ignore fully lowercaseinheritDoc
tags and
ignoreUnescapedBraces
to disable warnings about unescaped{
and}
characters in comments.
Bug Fixes
--useTsLinkResolution
is no longer ignored within block tags, #2260.- The current namespace will also be expanded in the navigation on page load, #2260.
- Fixed flicker of navigation pane when reloading a page caused by updating expansion state after the page was loaded.
- Fixed an infinite loop if more than one entry point was provided, and all entry points were the same.
Thanks!
v0.24.5
Features
- Categories and groups can now be shown in the navigation, added
--navigation.includeCategories
and--navigation.includeGroups
to control this behavior. The--categorizeByGroup
option also
effects this behavior. IfcategorizeByGroup
is set (the default) andnavigation.includeGroups
is
not set, the value ofnavigation.includeCategories
will be effectively ignored since categories
will be created only within groups, #1532. - Added support for discovering a "module" comment on global files, #2165.
- Added copy code to clipboard button, #2153.
- Function
@returns
blocks will now be rendered with the return type, #2180. - Added
--groupOrder
option to specify the sort order of groups, #2251.
Bug Fixes
- Type parameter constraints now respect the
--hideParameterTypesInTitle
option, #2226. - Even more contrast fixes, #2248.
- Fix semantic highlighting for predicate type's parameter references, #2249.
- Fixed broken links to heading titles.
- Fixed inconsistent styling between type parameter lists and parameter lists.
- TypeDoc will now warn if more than one
@returns
block is is present in a function, and ignore the duplicate blocks as specified by TSDoc.
Thanks!
v0.24.4
v0.24.3
v0.24.2
Features
- Added semantic link coloring for reflection names & links, #2227.
Note: This resulted in function signatures becoming too busy for easy scanning with even slightly
complicated signatures as such, TypeDoc now only renders parameter names in the signature title
and includes the type in the parameter details as usual. This can be controlled with the new
--hideParameterTypesInTitle
option. - Conditional types will now render their branches on the next line for easier comprehension.
Bug Fixes
- Fixed
&
showing as&
and HTML text showing up in page contents navigation, #2224. - Increased padding between sections when one navigation column is displayed, #2225.
- Correct padding for navigation elements with a displayed icon, #2229.
- Fixed
source-order
sort strategy failing to compare reflections within a file. - Added
enum-member-source-order
specialization of thesource-order
sort strategy which only compares enum members, #2237. - Updated highlight colors for semantic links to meet WCAG AA contrast requirements, #2228.
- Type parameters are now highlighted consistently, #2230.
- Fixed semantic coloring in type and function signatures, #2227.
- Fixed issue where removing a reflection indirectly containing an object/function type would only partially remove the reflection, #2231.
- Fixed "Implementation of X.y" links if a mixture of methods and property-methods are used, #2233.
- "Implementation of" text to symbol-properties not contained in the documentation will now use the resolved name instead of a
__@
symbol name, #2234. - Fix expansion of globs if a single entry point is provided, #2235.
- Validation will no longer be skipped for sub packages when running with
--entryPointStrategy packages
. - Fixed broken theme toggle if the page contained a member named "theme".