chore(deps): update dependency typedoc to ^0.26.0 #196
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR contains the following updates:
^0.21.2
->^0.26.0
Release Notes
TypeStrong/TypeDoc (typedoc)
v0.26.7
Compare Source
Features
customJs
option to include a script tag in generated HTML output, #2650.markdownLinkExternal
option to treathttp[s]://
links in markdown documents and comments as external to be opened in a new tab, #2679.navigation.excludeReferences
option to prevent re-exports from appearing in the left hand navigation, #2685.@abstract
tag, #2692.Bug Fixes
@link
tags to symbols which are not included in the documentation will produce invalid link warnings again, #2681.@param
tags on comments attached to function callback parameters, #2683.alphabetical
andalphabetical-ignoring-documents
sort options now uselocaleCompare
to sort, #2684.this
parameter, #2698.Thanks!
v0.26.6
Compare Source
Features
@extends
block tag no longer produces warnings, #2659.This tag should only be used in JavaScript projects to specify the type parameters used when extending a parent class. It will not be rendered.
navigation.compactFolders
option to prevent TypeDoc from compacting folders, similar to the VSCode option. #2667.Bug Fixes
suppressCommentWarningsInDeclarationFiles
option now correctly ignores warnings in.d.cts
and.d.mts
files, #2647.v0.26.5
Compare Source
Features
OptionDefaults
, #2640.Bug Fixes
@document
includes an empty file, #2638.Thanks!
v0.26.4
Compare Source
Bug Fixes
@link
tags will now be validated in referenced markdown documents, #2629.@link
tags are now resolved in project documents, #2629.@hidden
is now properly applied when placed in a function implementation comment, #2634.Thanks!
v0.26.3
Compare Source
Features
Bug Fixes
mailto:
links are no longer incorrectly recognized as relative paths, #2613.@since
to the default list of recognized tags, #2614.v0.26.2
Compare Source
Features
--suppressCommentWarningsInDeclarationFiles
option to disable warnings fromparsing comments in declaration files, #2611.
for members of interfaces/classes, #2084, #2545.
Bug Fixes
text
non-highlighted language no longer causes warnings when rendering, #2610.use an
@param
tag from the parent, TypeDoc will no longer warn about the@param
tag.v0.26.1
Compare Source
Features
Bug Fixes
@author
to the default list of recognized tags, #2603..jsonc
configuration files are now properly read as JSONC, rather than being passed torequire
.Thanks!
v0.26.0
Compare Source
Breaking Changes
marked
tomarkdown-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 usemarkdownItOptions
.Unlike
marked@4
,markdown-it
pushes lots of functionality to plugins. To use plugins, a JavaScript config file must be used with themarkdownItLoader
option.As Shiki adds additional languages, the time it takes to load the highlighter increases linearly. To avoid rendering taking longer than necessary,
TypeDoc now only loads a few common languages. Additional languages can be loaded by setting the
--highlightLanguages
option.--excludePrivate
totrue
.--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 correspondinganalytics
theme member, #2600.were always moved down to the signature level. This mostly worked, but caused problems with type aliases, so was partially changed in 0.25.13.
This change was extended to apply not only to type aliases, but also other function-likes declared with variables and callable properties.
As a part of this change, comments on the implementation signature of overloaded functions will now be added to the function reflection, and will
not be inherited by signatures of that function, #2521.
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 toDeclarationReflection.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 totypeParameters
to match the JS API.DefaultThemeRenderContext.iconsCache
has been removed as it is no longer needed.DefaultThemeRenderContext.hook
must now be passedcontext
if required by the hook.Features
--projectDocuments
option to specify additional Markdown documents to be included in the generated site #247, #1870, #2288, #2565.are currently shipped in the package, but it is now possible to add support for additional languages, #2475.
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.Note: This feature is only available on type aliases directly containing unions.
--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
, andalphabetical-ignoring-documents
to order markdown documents.--alwaysCreateEntryPointModule
option. When set, TypeDoc will always create aModule
for entry points, even if only one is provided.If
--projectDocuments
is used to add documents, this option defaults totrue
, otherwise, defaults tofalse
.--highlightLanguages
option to control what Shiki language packages are loaded.This results in significantly smaller documentation pages in many cases where that section would just repeat what has already been presented in the rendered type.
comment.beforeTags
andcomment.afterTags
hooks for plugin use.Combined with
CommentTag.skipRendering
this can be used to provide custom tag handling at render time.Bug Fixes
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.Thanks!
v0.25.13
Compare Source
Features
gitRevision:short
placeholder option to--sourceLinkTemplate
option, #2529.Links generated by TypeDoc will now default to using the non-short git revision.
<footer>
tag, addedfooter.begin
andfooter.end
render hooks for use by custom plugins, #2532.
Bug Fixes
NoInfer
missing type parameter reference, #2539."This member is normally hidden due to your filter settings" for every member.
Thanks!
v0.25.12
Compare Source
Bug Fixes
Thanks!
v0.25.11
Compare Source
Bug Fixes
h1>h2>h3
process, #2515.v0.25.10
Compare Source
Bug Fixes
@interface
, #2508.For TypeDoc's docs, this reduced the rendered documentation size by ~30%.
v0.25.9
Compare Source
Features
Bug Fixes
--excludeNotDocumented
was used and the project contained a reference to a removed signature, #2496.--maxTypeConversionDepth
option, #2507.Thanks!
v0.25.8
Compare Source
v0.25.7
Compare Source
Bug Fixes
v0.25.6
Compare Source
Bug Fixes
v0.25.5
Compare Source
v0.25.4
Compare Source
Features
This can be controlled through the new
DefaultThemeRenderContext.reflectionPreview
helper.Bug Fixes
gitRevision
will now be replaced insourceLinkTemplate
, #2434.Object.assign
, #2436.skipLibCheck
is used to ignore some compiler errors, #2438.@example
tag titles will now be rendered in the example heading, #2440.@namespace
-created namespaces, #2444.Thanks!
v0.25.3
Compare Source
Features
--sourceLinkExternal
option to render source code links as external, #2415.declarationMap
option to be set to true to handle cross-package links in packages mode, #2416.external-last
option for the--sort
option, #2418.Bug Fixes
Thanks!
v0.25.2
Compare Source
Features
navigationLeaves
option to remove branches from the navigation tree, #2382.sortEntryPoints
option (defaults to true) to allow disabling entry point sorting, #2393.Bug Fixes
@template
constraints on JSDoc defined type parameters, #2389.declare module "foo"
, #2401.Thanks!
v0.25.1
Compare Source
Features
stripYamlFrontmatter
config option to remove YAML frontmatter from README.md, #2381.--excludeCategories
config option to remove reflections present in any excluded category, #1407.with large projects and also provides large space benefits. Themes may now override
DefaultTheme.buildNavigation
to customize the displayed navigation tree, #2287.
Note: This change renders
navigation.fullTree
obsolete. If you set it, TypeDoc will warn that it is being ignored.It will be removed in v0.26.
DefaultThemeRenderContext.icons
is overwritten by a custom theme.Note: To perform this optimization, TypeDoc relies on
DefaultThemeRenderContext.iconCache
being rendered withineach page. TypeDoc does it in the
defaultLayout
template.Bug Fixes
@property
now works as expected if used to override a method's documentation.--watch
mode works again, #2378.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
Compare Source
Breaking Changes
legacy-packages
option for--entryPointStrategy
.--categorizeByGroup
tofalse
.gitRemote
is no longer supported.Application
instance must now be retrieved viaApplication.bootstrap
orApplication.bootstrapWithPlugins
, #2268.ReflectionKind.ObjectLiteral
that was never used by TypeDoc.DefaultThemeRenderContext.comment
andDefaultThemeRenderContext.attemptExternalResolution
.Features
--preserveLinkText
option (defaults to true) which determines whether the reflection name or full link text is includedin the output when no override is specified, #2355.
site from ~5.6 seconds to ~5.4 seconds.
--disableGit
option to prevent TypeDoc from using Git to try to determine if sources can be linked, #2326.@showGroups
,@hideGroups
,@showCategories
,@hideCategories
to configure the navigation pane on aper-reflection basis, #2329.
--jsDocCompatibility.defaultTags
set,@defaultValue
is now implicitly a code block if the text contains no code, #2370.Bug Fixes
Foo#bar
) links were used and--useTsLinkResolution
is enabled in some cases, #2360.@inheritDoc
was not properly resolved across packages in packages mode, #2331.@interface
use on union types, #2352.Theme.getUrls
, #2318.@namespace
is used on a variable with an associated namespace, #2364.@namespace
property discovery if merged with a type and the type was declared first #2364.reflection.sources
now considers the node's name like non-signature location discovery does.Thanks!
v0.24.8 (2023-06-04)
Features
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.
--pretty
option now also controls whether generated HTML contains line breaks, #2287.MarkdownEvent.INCLUDE
for plugins, #2284.Bug Fixes
and any other block tags in the order they are defined in the comment, #2285.
Thanks!
v0.24.7 (2023-05-08)
Features
Bug Fixes
sort
option, #2272.v0.24.6 (2023-04-24)
Features
g
,circle
,ellipse
,polygon
, andpolyline
svg elements, #2259.jsDocCompatibility
option withinheritDocTag
to ignore fully lowercaseinheritDoc
tags andignoreUnescapedBraces
to disable warnings about unescaped{
and}
characters in comments.Bug Fixes
--useTsLinkResolution
is no longer ignored within block tags, #2260.Thanks!
v0.24.5 (2023-04-22)
Features
--navigation.includeCategories
and
--navigation.includeGroups
to control this behavior. The--categorizeByGroup
option alsoeffects this behavior. If
categorizeByGroup
is set (the default) andnavigation.includeGroups
isnot set, the value of
navigation.includeCategories
will be effectively ignored since categorieswill be created only within groups, #1532.
@returns
blocks will now be rendered with the return type, #2180.--groupOrder
option to specify the sort order of groups, #2251.Bug Fixes
--hideParameterTypesInTitle
option, #2226.@returns
block is is present in a function, and ignore the duplicate blocks as specified by TSDoc.Thanks!
v0.24.4 (2023-04-16)
Bug Fixes
v0.24.3 (2023-04-16)
Bug Fixes
v0.24.2 (2023-04-15)
Features
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.Bug Fixes
&
showing as&
and HTML text showing up in page contents navigation, #2224.source-order
sort strategy failing to compare reflections within a file.enum-member-source-order
specialization of thesource-order
sort strategy which only compares enum members, #2237.__@​
symbol name, #2234.--entryPointStrategy packages
.Thanks!
v0.24.1 (2023-04-09)
Bug Fixes
@example
tags, #2222.v0.24.8
Compare Source
Features
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.
--pretty
option now also controls whether generated HTML contains line breaks, #2287.MarkdownEvent.INCLUDE
for plugins, #2284.Bug Fixes
and any other block tags in the order they are defined in the comment, #2285.
Thanks!
v0.24.7
Compare Source
Features
Bug Fixes
sort
option, #2272.v0.24.6
Compare Source
Features
g
,circle
,ellipse
,polygon
, andpolyline
svg elements, #2259.jsDocCompatibility
option withinheritDocTag
to ignore fully lowercaseinheritDoc
tags andignoreUnescapedBraces
to disable warnings about unescaped{
and}
characters in comments.Bug Fixes
--useTsLinkResolution
is no longer ignored within block tags, #2260.Thanks!
v0.24.5
Compare Source
Features
--navigation.includeCategories
and
--navigation.includeGroups
to control this behavior. The--categorizeByGroup
option alsoeffects this behavior. If
categorizeByGroup
is set (the default) andnavigation.includeGroups
isnot set, the value of
navigation.includeCategories
will be effectively ignored since categorieswill be created only within groups, #1532.
@returns
blocks will now be rendered with the return type, #2180.--groupOrder
option to specify the sort order of groups, #2251.Bug Fixes
--hideParameterTypesInTitle
option, #2226.@returns
block is is present in a function, and ignore the duplicate blocks as specified by TSDoc.Thanks!
v0.24.4
Compare Source
Bug Fixes
v0.24.3
Compare Source
Bug Fixes
v0.24.2
Compare Source
Features
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.Bug Fixes
&
showing as&
and HTML text showing up in page contents navigation, #2224.source-order
sort strategy failing to compare reflections within a file.enum-member-source-order
specialization of thesource-order
sort strategy which only compares enum members, [#2237](https://github.com/TypeStrong/TyConfiguration
📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about this update again.
This PR was generated by Mend Renovate. View the repository job log.