Releases: TypeStrong/typedoc
Releases · TypeStrong/typedoc
v0.23.19
v0.23.18
Features
Bug Fixes
v0.23.17
Features
- Added
titleLink
,navigationLinks
andsidebarLinks
options to add additional links to the rendered output, #1830. - Added
sourceLinkTemplate
option to allow more flexible specification of remote urls.
Deprecated now redundantgitRevision
detection starting withhttps?://
introduced in v0.23.16, #2068.
Thanks!
v0.23.16
Features
- Object types will now be pretty printed, #1793.
- Added support for specifying the tsconfig.json file in packages mode with
{ "typedoc": { "tsconfig": "tsconfig.lib.json" }}
in package.json, #2061. - In packages mode, readme files will now be automatically included if present, #2065.
- Added support for specifying the base file url for links to source code, #2068.
Bug Fixes
- Private parameter properties will no longer be ignored, #2064.
Thanks!
- @captainTorch
v0.23.15
Features
- TypeDoc will now treat
@typedef {import("foo").Bar<Z>} Baz
type declarations which forward type parameters to the imported
symbol as re-exports of that symbol, #2044.
Bug Fixes
- TypeDoc will now prefer comments on variable declarations over signature comments, #2042.
- Fixed double rendering of "Type Parameters" header, #2054.
- Fixed double rendering of "Hierarchy" header, #2053.
- Removed unused
widgets.png
and[email protected]
files from generated assets folder.
v0.23.14
Features
- Added support for defining one-off external link mappings with
externalSymbolLinkMappings
see
the documentation for usage examples and caveats, #2030. - External link resolvers defined with
addUnknownSymbolResolver
will now be checked when resolving@link
tags, #2030.
Note: To support this, resolution will now happen during conversion, and as such,Renderer.addUnknownSymbolResolver
has been
soft deprecated in favor ofConverter.addUnknownSymbolResolver
. Plugins should update to use the method onConverter
.
DefaultThemeRenderContext.attemptExternalResolution
has also been deprecated since it will repeat work done during conversion,
useReferenceType.externalUrl
instead. - Added
Converter.addUnknownSymbolResolver
for use by plugins supporting external links.
Bug Fixes
v0.23.13
v0.23.12
Features
- Added a new
ParameterType.Object
for declaring object options which will be shallowly merged when read from user configuration. - Added a new
Application.EVENT_BOOTSTRAP_END
event emitted whenApplication.bootstrap
is called.
Bug Fixes
- TypeDoc will now work properly in packages mode when converting packages outside the current working directory, #2043.
- Fixed deprecation warning for
isIdentifierOrPrivateIdentifier
. - Fixed centering of title bar on wide displays, #2046.
Thanks!
v0.23.11
Features
- Added support for TypeScript 4.8.
- Introduced a
skipErrorChecking
option which instructs TypeDoc to not ask TypeScript for compiler errors
before attempting to generate documentation. Turning this on may improve generation speed, but could also
cause a crash if your code contains compiler errors. - Added support for JS entry points when using packages mode, #2037.
Bug Fixes
- Fixed crash when converting abstract mixin class, #2011.
- Readme files within monorepos now have
@link
tags resolved, #2029. - Correctly resolve unqualified links to class members within parameters, #2031.
- TypeDoc will now consider other reflections with the same name as parents when resolving links, #2033.
- The "Hierarchy" and "Type Parameters" helpers on
DefaultThemeRenderContext
now contain all the HTML for their sections of the page, #2038.
Thanks!
v0.23.10
Features
- Added support for detecting comments directly before parameters as the parameter comment, #2019.
- Added support for using the comment directly before a constructor parameter that declares a property as the property comment, #2019.
- Improved schema generation to give better autocomplete for the
sort
option. - Optional properties are now visually distinguished in the index/sidebar by rendering
prop
asprop?
, #2023. DefaultThemeRenderContext.markdown
now also accepts aCommentDisplayPart[]
for rendering, #2004.- Expose
Converter.resolveLinks
method for use withConverter.parseRawComment
, #2004.
Bug Fixes
- Fixed schema URL for TSDoc preventing the use of
typedoc/tsdoc.json
in TSDoc extends, #2015. - Improved detection of package names in repositories using pnpm, #2017.
- Fixed missing JSDoc style
@typedef
comments for properties, #2020.