Repository navigation
chore(deps): update dependency typedoc to ^0.28.0 - #105
Open
renovate[bot] wants to merge 1 commit into
Open
renovate[bot] wants to merge 1 commit into
renovate[bot] wants to merge 1 commit into
Conversation
renovate
Bot
force-pushed
the
renovate/typedoc-0.x
branch
4 times, most recently
from
April 17, 2023 21:17
a516958 to
ecad984
Compare
renovate
Bot
force-pushed
the
renovate/typedoc-0.x
branch
2 times, most recently
from
May 28, 2023 15:41
89bc222 to
3f91a4e
Compare
renovate
Bot
force-pushed
the
renovate/typedoc-0.x
branch
from
July 6, 2023 11:23
3f91a4e to
2f649c5
Compare
renovate
Bot
force-pushed
the
renovate/typedoc-0.x
branch
2 times, most recently
from
August 9, 2023 18:13
1eaa482 to
bb5256d
Compare
renovate
Bot
force-pushed
the
renovate/typedoc-0.x
branch
from
August 25, 2023 23:19
bb5256d to
2f7574b
Compare
renovate
Bot
force-pushed
the
renovate/typedoc-0.x
branch
from
September 4, 2023 15:36
2f7574b to
fa0986d
Compare
renovate
Bot
force-pushed
the
renovate/typedoc-0.x
branch
from
September 22, 2023 23:10
fa0986d to
c9681c5
Compare
renovate
Bot
force-pushed
the
renovate/typedoc-0.x
branch
2 times, most recently
from
October 23, 2023 19:15
4b8f109 to
2a02857
Compare
renovate
Bot
force-pushed
the
renovate/typedoc-0.x
branch
from
December 13, 2023 19:07
2a02857 to
f3744f8
Compare
renovate
Bot
force-pushed
the
renovate/typedoc-0.x
branch
from
January 7, 2024 07:56
f3744f8 to
b7c5572
Compare
renovate
Bot
force-pushed
the
renovate/typedoc-0.x
branch
from
January 23, 2024 22:51
b7c5572 to
0c684ab
Compare
renovate
Bot
force-pushed
the
renovate/typedoc-0.x
branch
from
February 17, 2024 18:24
0c684ab to
3aceac7
Compare
renovate
Bot
force-pushed
the
renovate/typedoc-0.x
branch
3 times, most recently
from
April 26, 2024 12:17
431e8db to
d8587ad
Compare
renovate
Bot
force-pushed
the
renovate/typedoc-0.x
branch
from
May 9, 2024 00:23
d8587ad to
ae29871
Compare
renovate
Bot
force-pushed
the
renovate/typedoc-0.x
branch
3 times, most recently
from
May 21, 2024 05:43
3047d03 to
42bd5e2
Compare
renovate
Bot
force-pushed
the
renovate/typedoc-0.x
branch
2 times, most recently
from
June 13, 2024 20:42
1d59c1f to
58e8fdf
Compare
renovate
Bot
force-pushed
the
renovate/typedoc-0.x
branch
from
June 22, 2024 03:03
58e8fdf to
e4f4ec3
Compare
renovate
Bot
force-pushed
the
renovate/typedoc-0.x
branch
from
August 1, 2025 18:46
d40b2f4 to
e0b17f3
Compare
renovate
Bot
force-pushed
the
renovate/typedoc-0.x
branch
2 times, most recently
from
August 10, 2025 21:36
4886528 to
bc7170c
Compare
renovate
Bot
force-pushed
the
renovate/typedoc-0.x
branch
2 times, most recently
from
August 25, 2025 04:56
5f63e32 to
835958e
Compare
renovate
Bot
force-pushed
the
renovate/typedoc-0.x
branch
2 times, most recently
from
September 6, 2025 22:36
931021a to
052da82
Compare
renovate
Bot
force-pushed
the
renovate/typedoc-0.x
branch
from
September 15, 2025 01:24
052da82 to
03e50c6
Compare
renovate
Bot
force-pushed
the
renovate/typedoc-0.x
branch
from
September 25, 2025 20:27
03e50c6 to
5d532b3
Compare
renovate
Bot
force-pushed
the
renovate/typedoc-0.x
branch
from
October 11, 2025 04:42
5d532b3 to
2b8d985
Compare
renovate
Bot
force-pushed
the
renovate/typedoc-0.x
branch
from
October 21, 2025 11:46
2b8d985 to
0103475
Compare
renovate
Bot
force-pushed
the
renovate/typedoc-0.x
branch
from
November 10, 2025 13:57
0103475 to
ae6b210
Compare
renovate
Bot
force-pushed
the
renovate/typedoc-0.x
branch
2 times, most recently
from
December 3, 2025 18:51
1177706 to
f83c121
Compare
renovate
Bot
force-pushed
the
renovate/typedoc-0.x
branch
from
December 31, 2025 12:55
f83c121 to
bd065b1
Compare
renovate
Bot
force-pushed
the
renovate/typedoc-0.x
branch
2 times, most recently
from
January 12, 2026 01:12
1281e92 to
f11c980
Compare
renovate
Bot
force-pushed
the
renovate/typedoc-0.x
branch
from
February 2, 2026 21:26
f11c980 to
4a797e0
Compare
renovate
Bot
force-pushed
the
renovate/typedoc-0.x
branch
2 times, most recently
from
February 13, 2026 21:37
58b7df1 to
b962383
Compare
renovate
Bot
force-pushed
the
renovate/typedoc-0.x
branch
from
March 5, 2026 17:56
b962383 to
7f90ac2
Compare
renovate
Bot
force-pushed
the
renovate/typedoc-0.x
branch
2 times, most recently
from
March 27, 2026 13:21
36fd0d2 to
0a3f4a8
Compare
renovate
Bot
force-pushed
the
renovate/typedoc-0.x
branch
from
April 1, 2026 19:45
0a3f4a8 to
765934b
Compare
renovate
Bot
force-pushed
the
renovate/typedoc-0.x
branch
from
April 12, 2026 04:37
765934b to
eb4401e
Compare
renovate
Bot
force-pushed
the
renovate/typedoc-0.x
branch
from
May 12, 2026 12:40
eb4401e to
16d91c3
Compare
renovate
Bot
force-pushed
the
renovate/typedoc-0.x
branch
from
May 28, 2026 13:57
16d91c3 to
fa8a46d
Compare
renovate
Bot
force-pushed
the
renovate/typedoc-0.x
branch
2 times, most recently
from
July 12, 2026 13:02
7a956ef to
8d4ce8a
Compare
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Note
This PR body was truncated due to platform limits.
This PR contains the following updates:
^0.23.18→^0.28.0Release Notes
TypeStrong/TypeDoc (typedoc)
v0.28.20Compare Source
Features
<h2>) in the default theme now include anidattribute so they can be linked to via fragment identifiers (e.g.modules.html#classes), #3029.@reexportmodifier tag to have TypeDoc convert variable/type references as a re-export instead of a new symbol, #3096.generateOutputsBeginandgenerateOutputsEndevents onApplicationfor plugin use.Bug Fixes
--emit noneis used, TypeDoc will now report warnings about missing relative paths previously reported when rendering, #3078.@hiddentag on a constructor parameter-property will now only hide the property, not both the property and the parameter, #3111.@groupand@categorytitles with the same sort weight are now ordered consistently with thealphabeticalreflection sort, #3120.Thanks!
v0.28.19Compare Source
Features
triple-slashcomment style, which requires exactly three slashes in the comment, #3089.Bug Fixes
Thanks!
v0.28.18Compare Source
Features
v0.28.17Compare Source
Bug Fixes
$, #3065.pluginoption to permit functions, #3066.@paramtags will now be properly suppressed when they come from declaration files andthe suppressCommentWarningsInDeclarationFiles option is enabled, #3070.
Thanks!
v0.28.16Compare Source
Bug Fixes
cause TypeDoc to infer the wrong path when resolving base paths for display.
markdownItLoaderto override more rendering #3055.Features
@includein.tsx,.cjs, and.mjsfile references #3048.@typedeftags may now specify modifier tags with the inline tag syntax{@mod}.This makes it possible to add modifier tags to these members, which previously was not possible as
TypeScript's parsing stops for these members at the next non-braced tag, #2916 and #3050.
typedoc-config.schema.jsonis now included in the root of the package with a JSON schema for TypeDoc'sconfiguration file. The schema for the latest version is also published at https://typedoc.org/schema.json
and will automatically be picked up when writing typedoc.json files if you are using VSCode, #3054.
Thanks!
v0.28.15Compare Source
Features
gitRevisionoption now accepts the special value{branch}, which indicates source links should usethe current git branch for links, #3041.
validation.invalidPathfor suppressing warnings caused by referencing relative paths whichdo not exist when building the documentation, #3033.
Logger.validationWarningfor validation which occurs during conversion rather thanduring TypeDoc's normal validation step, #3033.
v0.28.14Compare Source
Features
preservedTypeAnnotationTagsoption to specify tags whose type annotations shouldbe copied to the output documentation, #3020.
API: Introduced
typeAnnotationonCommentTagexcludePrivateClassFieldsoption to hide#privatemembers while allowingprivatemembers, #3017.@thistag for JS files which describethisparameters, #3026.relevanceBoostonDeclarationReflectionfor plugin use, #3036.Bug Fixes
accessorkeyword, #3019.@microsoft/tsdoc-configversion 0.18.0, #3035.Thanks!
v0.28.13Compare Source
Features
basePathoption now also affects relative link resolution, TypeDoc will also check forpaths relative to the provided base path. If you instead want TypeDoc to only change the rendered
base path for sources, use the
displayBasePathoption, #3009.Bug Fixes
@inheritDocwill now correctly overwrite@remarksand@returnsblocks on the target comment, #3012.externalSymbolLinkMappingsoption now works properly on links pointing to inherited/overwritten signatures, #3014.v0.28.12Compare Source
Bug Fixes
@enumnow work for symbols imported from another module, #3003.API:
Reflection.hasCommentandComment.hasVisibleComponentnow accepts an optionalnotRenderedTagsparameter.v0.28.11Compare Source
Features
if they do not have their own comment, #2999.
Bug Fixes
?in the reflection preview and signature, #2995.compilerOptionsoption now functions properly with non-boolean options, #3000.compilerOptionsoption are now handled gracefully, #3000.v0.28.10Compare Source
Bug Fixes
v0.28.9Compare Source
Features
Bug Fixes
v0.28.8Compare Source
Features
pluginfunction can now be given plugin functions to load.-within tag names to supporttypescript-json-schema's@TJS-typetag, #2972.Context.createSymbolIdfor use by plugins.Bug Fixes
<img srcset>will now be discovered by TypeDoc, #2975.<source src>and<source srcset>elements will now be discovered by TypeDoc, #2975.Thanks!
v0.28.7Compare Source
Features
@sortStrategytag to override thesortoption on a specific reflection, #2965.Bug Fixes
export { type X }are no longer missing comments, #2970.localeto an unknown value will now cause TypeDoc to operate in English instead of a debug locale.v0.28.6Compare Source
Features
Bug Fixes
export { type X }are now detected and converted as interfaces/type aliases, #2962.Thanks!
v0.28.5Compare Source
Bug Fixes
ignoredHighlightLanguagescan now be used to prevent warnings for codeblocks containing languageswhich are supported by Shiki but are not loaded, #2956.
v0.28.4Compare Source
Features
Bug Fixes
The
chevronSmallhelper is now deprecated and will be removed with v0.29.0.@hiddenwill no longer appear in the"Hierarchy" section of the docs.
Thanks!
v0.28.3Compare Source
Bug Fixes
@inlinenow functions when referencing tuple types, #2932.@linklinks to the current page are now rendered, #2934.@includeCodenow supports regions in TypeScript files with.mtsand.ctsfile extensions, #2935.v0.28.2Compare Source
Features
<h2>) in the default theme now include anidattribute so they can be linked to via fragment identifiers (e.g.modules.html#classes), #3029.@reexportmodifier tag to have TypeDoc convert variable/type references as a re-export instead of a new symbol, #3096.generateOutputsBeginandgenerateOutputsEndevents onApplicationfor plugin use.Bug Fixes
--emit noneis used, TypeDoc will now report warnings about missing relative paths previously reported when rendering, #3078.@hiddentag on a constructor parameter-property will now only hide the property, not both the property and the parameter, #3111.@groupand@categorytitles with the same sort weight are now ordered consistently with thealphabeticalreflection sort, #3120.Thanks!
v0.28.1Compare Source
Features
triple-slashcomment style, which requires exactly three slashes in the comment, #3089.Bug Fixes
Thanks!
v0.28.0Compare Source
Breaking Changes
/path separators, #2825.--entryPointStrategy mergemode now requires JSON from at least version 0.28.0.jptranslations fromlang, to migrate switch toja.intentionallyNotExportednow use a package name/package relative path instead of an absolute path for matching.source-ordersort ordering now considers package names / package relative paths instead of using the absolute paths to a file.package.jsonfile if--readmeis not setthis change improves handling of monorepo setups where some packages have readme files and others do not, #2875.
they are initialized with a function expression. TypeDoc can be instructed to convert them as functions
with the
@functiontag, #2881.to how interfaces are rendered, #2817.
API Breaking Changes
ProjectReflection.getReflectionFromSymbolandProjectReflection.getSymbolFromReflectionhave been moved toContextPathandPathArrayparameter types now always contain normalized paths.Routerwhich is used for URL creation.Reflection.url,Reflection.anchor, andReflection.hasOwnDocumenthave been removed.Deserializer.reviveProject(s)no longer accepts an option to add project documents.Deserializer.reviveProjectsnow requires analwaysCreateEntryPointModuleoption.Comment.serializeDisplayPartsno longer requires a serializer argument.ReflectionSymbolId.fileNameis now optional, TypeDoc now stores a combination of a package name and package relative path instead.The
fileNameproperty will be present when initially created, but is not serialized.DeclarationReflection.relevanceBoostattribute which was added for plugins, but never used.i18nproxy is no longer passed to many functions, instead, referencei18nexported from the module directly.ReflectionKind.singularStringandReflectionKind.pluralStringnow returns translated strings.The methods on
Internationalizationto do this previously have been removed.DefaultThemeRenderContext'stypeDeclarationandtypeDetailsIfUsefulmethods now require both a reflection and a type in order to support
@expandTypeFeatures
--routeroption which can be used to modify TypeDoc's output folderstructure. This can be extended with plugins, #2111.
@primaryExportmodifier tag to provide more fine grainedcontrol over export conversion order, #2856
packagesRequiringDocumentationoption forvalidation.notDocumented, TypeDoc will expect comments to be present for symbols in the specified packages.typedoc/browserentrypoint for parsing and using serialized JSON files, #2528.packageOptionsasPartial<TypeDocOptions>, #2878.packageOptions, #2878.@functiontag to force TypeDoc to convert variable declarations with a type annotation as functions, #2881.TypeDocglobal object in the HTML theme which can be used to prevent TypeDoc from usinglocalStorage, #2872.@preventInlineand@inlineTypetags for further control extending the@inlinetag, #2862.@preventExpandand@expandTypetags for further control extending the@expandtag, #2862.DefaultThemeRenderContext.reflectionIconfor more granular control over displayed reflection icons.Bug Fixes
Thanks!
v0.27.9Compare Source
This will be the last v0.27.x release, see #2868 for discussion on the 0.28 beta.
Features
v0.27.8Compare Source
Features
visibilityFilteroption now supports individual signatures, #2846.faviconoption may now be given a link starting withhttps?://instead of a path, #2851.#as the link inexternalSymbolLinkMappingsto indicate the type should not be linked to, #2853.Bug Fixes
undefined, #2854.Thanks!
v0.27.7Compare Source
Features
@includeCodeand@inlinecan now inject parts of files using regionnames or line numbers, #2816.
jatranslation options, deprecatedjpin favor ofja, #2843.--watchoption to support watching files not caught byTypeScript's watch mode, #2675.
@inlinetag now works in more places for generic types.Bug Fixes
@classincorrectly handling mapped types, #2842.so that declaration merged members with global symbols can be documented, #2844.
Thanks!
v0.27.6Compare Source
Features
ignoredHighlightLanguagesoption to specify languages which will beallowed in code blocks but not highlighted, #2819.
Bug Fixes
@includeand@includeCodenow work in the readme file, #2814.same symbol over type literal properties within function parameters.
v0.27.5Compare Source
Bug Fixes
deeply nested properties. This only affects links to properties of
properties of types, which did not have a clickable link exposed so are
unlikely to have been linked to. Furthermore, these links were not always
created by TypeDoc, only being created if all parent properties contained
comments, #2808.
rendered document and the parent property/page will be linked to instead,
#2808. These warnings can be disabled with the
validation.rewrittenLinkoption.
https://links under thehostedBaseUrloption's URL will nolonger be treated as external, #2809.
Thanks!
v0.27.4Compare Source
Features
Converter.EVENT_CREATE_PROJECTevent which fires when a project is created by the converter, #2800.Bug Fixes
@includeand@includeCodenow work for comments on the entry point for projects with a single entry point, #2800.@summarynow works to describe functions within modules, #2803.v0.27.3Compare Source
Features
Bug Fixes
highlightLanguagesoption now permits Shiki aliases to be specified rather than just the language ID, #2798.Thanks!
v0.27.2Compare Source
Bug Fixes
v0.27.1Compare Source
Bug Fixes
@categoryDescriptionand@groupDescriptionon module pages, #2787.v0.27.0Compare Source
Breaking Changes
result in a different file name structure, #2714.
have changed. They can be partially restored to the previous format by
setting
--sluggerConfiguration.lowercase false. This change was made tomore closely match the default behavior of GitHub's markdown rendering and
VSCode's autocomplete when creating a relative link to an external markdown
file.
hideParameterTypesInTitleoption, this was originally added asa workaround for many signatures overflowing the available horizontal space
in rendered pages. TypeDoc now has logic to wrap types/signatures smartly,
so this option is no longer necessary.
kindSortOrderto put references last.sortorder to usealphabetical-ignoring-documentsinstead of
alphabetical.suppressCommentWarningsInDeclarationFilestotrue(e.g.
X, notnew X)@group,@category,@groupDescriptionand@categoryDescriptionwill no longer be removed from the reflections they are present on. They are
skipped during rendering with the
notRenderedTagsoption.Features
package.jsonexports if theyare not provided manually, #1937.
#anchorlinks toreference a heading within them.
@paramcomments with nested object types, #2555.@paramcomments which reference a typealias/interface. Important properties on the referenced type can now be
highlighted with
@param options.foo, which will result in the additionalnote being included under the documentation for that parameter, #2147. Note:
This feature is limited to references. It is not supported on other types of
types.
outputsoption which is an array of outputs. This can be usedto render the documentation multiple times with different rendering options
or output types, #2597.
@expandtag which can be placed on type aliases andinterfaces. When a type with
@expandis referenced and TypeDoc has a placeto include additional details about the type, the properties of the type
will be included in the page where
@expandis found. Note that use of thistag can significantly increase the size of your generated documentation if
it is applied to commonly used types as it will result in inlining the
comments for those types everywhere they are referenced, #2303.
@inlinetag which can be placed on type aliases andinterfaces. When a type with
@inlineis referenced, TypeDoc will resolvethe referenced type and convert the type as if it was included directly
within the referencing type. Note that use of this tag can significantly
increase the size of your generated documentation if it is applied to
commonly used types as it will result in inlining the comments for those
types everywhere they are referenced, #2303.
@useDeclaredTypetag for type aliases which can sometimesimprove their documentation, #2654.
@mergeModuleWithtag which can be used to tell TypeDoc toplace a module/namespace's children under a different module/namespace and
remove the real parent, #2281.
@includeand@includeCodeinline tags to include files withincomments/documents.
notRenderedTagsoption. This option is similar to theexcludeTagsoption, but while
excludeTagswill result in the tag being completelyremoved from the documentation,
notRenderedTagsonly prevents it frombeing included when rendering.
groupReferencesByTypeoption.navigation.excludeReferencesoptionuseFirstParagraphOfCommentAsSummaryoption to configure how TypeDochandles comments for module members without the
@summarytag.faviconoption to specify a.icoor.svgfavicon to reference.together and will expand/collapse together, #2335.
app.outputsobject for defining new output strategies.@layer typedoc, #2782.Bug Fixes
readonlyindex signatures.overloads if present, #2718.
@enumif the type was declared before the variable, #2719.declared inside
declare global, #2774declare module "foo"as a module rather than a namespace, #2778.cases. This primarily affected destructured parameters.
yamlto the highlight languages supported by default.txtas an alias oftextto indicate a code blockshould not be highlighted.
@ignoreor@hiddenbut still referenced byother types will no longer produce warnings about not being exported.
module when resolving
@linktags.JavaScript is disabled.
rather than when converting. This prevents issues where boosts used by just
one package were incorrectly reported as unused when running with
entryPointStrategy set to packages.
Thanks!
[
v0.26.11](https://redirect.github.com/TypeStrong/TypeDoc/bConfiguration
📅 Schedule: (UTC)
🚦 Automerge: Enabled.
♻ 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.