Releases: TypeStrong/typedoc
Releases · TypeStrong/typedoc
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.
Thanks!
v0.23.9
Bug Fixes
- TypeDoc will no longer skip entry points which have no exports, #2007.
If using"entryPointStrategy": "expand"
, this change may result in new pages being added to your documentation.
If this is not desired, you can use theexclude
option to filter them out. - Fixed missing comments on callable variable-functions constructed indirectly, #2008.
- Packages mode will now respect the
--includeVersion
flag, #2010. - Fixed multiple reflections mapping to the same file name on case insensitive file systems, #2012.
v0.23.8
Features
- Added defined in links for classes, enums, #180.
- Added support for
*.ghe.com
and*.github.us
GitHub enterprise domains for source links, #2001. - Expose
Converter.parseRawComment
for plugins to parse additional markdown files, #2004.
Bug Fixes
- TypeDoc will no longer emit a warning for
{@link}
containing a URL, #1980. excludeNotDocumented
will no longer remove functions/methods/accessors which are documented, #1994.- Fixed missing
sources
property on signature reflections #1996.
Thanks!
v0.23.7
Bug Fixes
- Tags must now contain whitespace after the tag name to be parsed as a tag,
@jest/globals
in a comment will no longer be parsed as a tag #1990. - The private member visibility option will now be respected in generated sites, #1992.
- Overload rendering will no longer be broken if JavaScript is disabled, #453.
- All overloads are now shown at once rather than requiring clicks to see the documentation for each signature, #1100.
v0.23.6
Features
- Improved support for
--entryPointStrategy Packages
. TypeDoc will now load package-specific configurations frompackage.json
typedoc
field. This configuration allows configuring a custom display name (typedoc.displayName
) field, entry point (typedoc.entryPoint
- this is equivalent and will overridetypedocMain
), and path to a readme file to be rendered at the top of the package page (typedoc.readmeFile
), #1658. - The
--includeVersion
option will now be respected by--entryPointStrategy Packages
. Also, for this combination, missingversion
field in the rootpackage.json
will not issue a warning. - The
navigation
partial will now call the newsettings
,primaryNavigation
, andsecondaryNavigation
partials, #1987.
Bug Fixes
- All warnings will be reported instead of only the first warning of a given type, #1981.
- Include references will no longer be incorrectly parsed as links, #1986.
- The generated schema.json on the website will now use enum values rather than enum names if possible.
Thanks!
v0.23.5
Features
- The
DEBUG_SEARCH_WEIGHTS
global variable can now be set onwindow
to add search scoring information in the search results. - TypeDoc's icons are now available on
DefaultThemeRenderContext.icons
for use/modification by themes.