Changelog
v0.26.2 (2024-06-24)
--suppressCommentWarningsInDeclarationFiles
option to disable warnings from
parsing comments in declaration files, #2611.text
non-highlighted language no longer causes warnings when rendering, #2610.@param
tag from the parent, TypeDoc will no longer warn about the @param
tag.Changelog
v0.26.1 (2024-06-22)
@author
to the default list of recognized tags, #2603..jsonc
configuration files are now properly read as JSONC, rather than being passed to require
.Changelog
v0.26.0 (2024-06-22)
marked
to markdown-it
for parsing as marked has moved to an async model which supporting would significantly complicate TypeDoc's rendering code.
This means that any projects setting markedOptions
needs to be updated to use markdownItOptions
.
Unlike marked@4
, markdown-it
pushes lots of functionality to plugins. To use plugins, a JavaScript config file must be used with the markdownItLoader
option.--highlightLanguages
option.--excludePrivate
to true
.--sitemapBaseUrl
to --hostedBaseUrl
to reflect that it can be used for more than just the sitemap.navigation.fullTree
option.--media
option, TypeDoc will now detect image links within your comments and markdown documents and automatically copy them to the site.--includes
option, use the @document
tag instead.--stripYamlFrontmatter
option, TypeDoc will always do this now.--htmlLang
option to --lang
.--gaId
option for Google Analytics integration and corresponding analytics
theme member, #2600.Converter.EVENT_CREATE_DECLARATION
was emitted for ProjectReflection
in some circumstances.MapOptionDeclaration.mapError
has been removed.BindOption
decorator has been removed.DeclarationReflection.indexSignature
has been renamed to DeclarationReflection.indexSignatures
.
Note: This also affects JSON serialization. TypeDoc will support JSON output from 0.25 through at least 0.26.JSONOutput.SignatureReflection.typeParameter
has been renamed to typeParameters
to match the JS API.DefaultThemeRenderContext.iconsCache
has been removed as it is no longer needed.DefaultThemeRenderContext.hook
must now be passed context
if required by the hook.--projectDocuments
option to specify additional Markdown documents to be included in the generated site #247, #1870, #2288, #2565.packageOptions
object which specifies options that should be applied to each entry point when running with --entryPointStrategy packages
, #2523.--hostedBaseUrl
will now be used to generate a <link rel="canonical">
element in the project root page, #2550.--customFooterHtml
to add custom HTML to the generated page footer, #2559.--cascadedModifierTags
option, #2056.@alpha
and @beta
), #2056.@hideconstructor
tag.
This tag should only be used to work around TypeScript#58653, prefer the more general @hidden
/@ignore
tag to hide members normally, #2577.--useHostedBaseUrlForAbsoluteLinks
option to use the --hostedBaseUrl
option to produce absolute links to pages on a site, #940.--blockTags
option.documents-first
, documents-last
, and alphabetical-ignoring-documents
to order markdown documents.--alwaysCreateEntryPointModule
option. When set, TypeDoc will always create a Module
for entry points, even if only one is provided.
If --projectDocuments
is used to add documents, this option defaults to true
, otherwise, defaults to false
.--highlightLanguages
option to control what Shiki language packages are loaded.comment.beforeTags
and comment.afterTags
hooks for plugin use.
Combined with CommentTag.skipRendering
this can be used to provide custom tag handling at render time.Returns
header are now properly colored, #2546.navigationLinks
option are now moved into the pull out navigation on mobile displays, #2548.@license
and @import
comments will be ignored at the top of files, #2552.charset
is now correctly cased in <meta>
tag generated by the default theme, #2568.<head>
element could result in broken icons, #2589.@default
and @defaultValue
blocks are now recognized as regular blocks if they include inline tags, #2601.localStorage
.--hideParameterTypesInTitle
option no longer applies when rendering function types.@link
tags in readme files will now cause a warning when link validation is enabled.externalSymbolLinkMappings
option's support for meanings in declaration references.type=button
attribute set to avoid being treated as submit buttons.--hostedBaseUrl
will now implicitly add a trailing slash to the generated URL.Changelog
v0.25.13 (2024-04-07)
gitRevision:short
placeholder option to --sourceLinkTemplate
option, #2529.
Links generated by TypeDoc will now default to using the non-short git revision.<footer>
tag, added footer.begin
and footer.end
render hooks for use by custom plugins, #2532.NoInfer
missing type parameter reference, #2539.