Changelog
v0.23.13 (2022-09-01)
Changelog
v0.23.12 (2022-08-31)
ParameterType.Object
for declaring object options which will be shallowly merged when read from user configuration.Application.EVENT_BOOTSTRAP_END
event emitted when Application.bootstrap
is called.isIdentifierOrPrivateIdentifier
.Changelog
v0.23.11 (2022-08-26)
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.@link
tags resolved, #2029.DefaultThemeRenderContext
now contain all the HTML for their sections of the page, #2038.Changelog
v0.23.10 (2022-07-31)
sort
option.prop
as prop?
, #2023.DefaultThemeRenderContext.markdown
now also accepts a CommentDisplayPart[]
for rendering, #2004.Converter.resolveLinks
method for use with Converter.parseRawComment
, #2004.typedoc/tsdoc.json
in TSDoc extends, #2015.@typedef
comments for properties, #2020.Changelog
v0.23.9 (2022-07-24)
"entryPointStrategy": "expand"
, this change may result in new pages being added to your documentation.
If this is not desired, you can use the exclude
option to filter them out.--includeVersion
flag, #2010.Changelog
v0.23.8 (2022-07-17)
*.ghe.com
and *.github.us
GitHub enterprise domains for source links, #2001.Converter.parseRawComment
for plugins to parse additional markdown files, #2004.{@link}
containing a URL, #1980.excludeNotDocumented
will no longer remove functions/methods/accessors which are documented, #1994.sources
property on signature reflections #1996.Changelog
v0.23.7 (2022-07-09)
@jest/globals
in a comment will no longer be parsed as a tag #1990.Changelog
v0.23.6 (2022-07-08)
--entryPointStrategy Packages
. TypeDoc will now load package-specific configurations from package.json
typedoc
field. This configuration allows configuring a custom display name (typedoc.displayName
) field, entry point (typedoc.entryPoint
- this is equivalent and will override typedocMain
), and path to a readme file to be rendered at the top of the package page (typedoc.readmeFile
), #1658.--includeVersion
option will now be respected by --entryPointStrategy Packages
. Also, for this combination, missing version
field in the root package.json
will not issue a warning.navigation
partial will now call the new settings
, primaryNavigation
, and secondaryNavigation
partials, #1987.Changelog
v0.23.5 (2022-07-02)
DEBUG_SEARCH_WEIGHTS
global variable can now be set on window
to add search scoring information in the search results.DefaultThemeRenderContext.icons
for use/modification by themes.Changelog
v0.23.4 (2022-07-02)
--entryPointStrategy Packages
is set, #1976.search.js
generated file.--exclude
option will now be respected by --entryPointStrategy Packages
and can be used to exclude package directories, #1959.IndexEvent
on the Renderer
when preparing the search index, #1953.--searchInComments
option to include comment text in the search index, #1553.
Turning this option on will increase the size of your search index, potentially by an order of magnitude.