You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Improved handling of comments for type aliases which have been declaration merged with functions, #3064.
Fixed anchor link generation to members named $, #3065.
Corrected typing of the plugin option to permit functions, #3066.
Warnings about unused @param tags will now be properly suppressed when they come from declaration files and
the suppressCommentWarningsInDeclarationFiles option is enabled, #3070.
Fixed conversion of types referencing type parameters on functions, #3071.
Fixed an issue causing TypeDoc to fail to generate documentation when implementing interfaces, #3052.
Fixed an issue preventing automatic entry point discovery on Windows, #3057.
Improved vertical positioning of text icons, #3056.
TypeDoc no longer includes source location information for type literal reflections. This could sometimes
cause TypeDoc to infer the wrong path when resolving base paths for display.
Adjusted markdown rendering to allow markdownItLoader to override more rendering #3055.
Features
Added support for regions for @include in .tsx, .cjs, and .mjs file references #3048.
Comments for TS-in-JS @typedef tags 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.
A typedoc-config.schema.json is now included in the root of the package with a JSON schema for TypeDoc's
configuration 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.
The gitRevision option now accepts the special value {branch}, which indicates source links should use
the current git branch for links, #3041.
Introduced validation.invalidPath for suppressing warnings caused by referencing relative paths which
do not exist when building the documentation, #3033.
API: Introduced Logger.validationWarning for validation which occurs during conversion rather than
during TypeDoc's normal validation step, #3033.
Introduced the preservedTypeAnnotationTags option to specify tags whose type annotations should
be copied to the output documentation, #3020.
API: Introduced typeAnnotation on CommentTag
Added excludePrivateClassFields option to hide #private members while allowing private members, #3017.
Added support for TypeScript's @this tag for JS files which describe this parameters, #3026.
The basePath option now also affects relative link resolution, TypeDoc will also check for
paths relative to the provided base path. If you instead want TypeDoc to only change the rendered
base path for sources, use the displayBasePath option, #3009.
Bug Fixes
Fixed bug introduced in 0.28.8 where TypeDoc could not render docs with some mixin classes, #3007.
@inheritDoc will now correctly overwrite @remarks and @returns blocks on the target comment, #3012.
The externalSymbolLinkMappings option now works properly on links pointing to inherited/overwritten signatures, #3014.
Variables marked with @enum now work for symbols imported from another module, #3003.
Improved magic introduced with #2999 to work with imported symbols, #3003.
Fixed relative link resolution to file names containing percent encoded URLs, #3006.
Linking to the project's README file with a relative link will now behave as expected, #3006.
Reduced unnecessary HTML element rendering in default theme.
API: Reflection.hasComment and Comment.hasVisibleComponent now accepts an optional notRenderedTags parameter.
References to type aliases defined as mapped types will now correctly create a reference to the type alias, #2954.
ignoredHighlightLanguages can now be used to prevent warnings for codeblocks containing languages
which are supported by Shiki but are not loaded, #2956.
TypeDoc's default theme now uses the same chevron for all collapsible elements, #2924
The chevronSmall helper is now deprecated and will be removed with v0.29.0.
Classes/interfaces marked with @hidden will no longer appear in the
"Hierarchy" section of the docs.
Introduced the preservedTypeAnnotationTags option to specify tags whose type annotations should
be copied to the output documentation, #3020.
API: Introduced typeAnnotation on CommentTag
Added excludePrivateClassFields option to hide #private members while allowing private members, #3017.
Added support for TypeScript's @this tag for JS files which describe this parameters, #3026.
TypeDoc now expects all input globs paths to be specified with / path separators, #2825.
TypeDoc's --entryPointStrategy merge mode now requires JSON from at least version 0.28.0.
Removed jp translations from lang, to migrate switch to ja.
File name references in intentionallyNotExported now use a package name/package relative path instead of an absolute path for matching.
The source-order sort ordering now considers package names / package relative paths instead of using the absolute paths to a file.
TypeDoc will only check for a project README file next to the discovered package.json file if --readme is not set
this change improves handling of monorepo setups where some packages have readme files and others do not, #2875.
Function-like variable exports will now only be automatically converted as function types if
they are initialized with a function expression. TypeDoc can be instructed to convert them as functions
with the @function tag, #2881.
Object literal type alias types will now be converted in a way which causes them to be rendered more similarly
to how interfaces are rendered, #2817.
API Breaking Changes
ProjectReflection.getReflectionFromSymbol and ProjectReflection.getSymbolFromReflection have been moved to Context
Path and PathArray parameter types now always contain normalized paths.
Introduced a Router which is used for URL creation. Reflection.url, Reflection.anchor, and Reflection.hasOwnDocument have been removed.
Deserializer.reviveProject(s) no longer accepts an option to add project documents.
Deserializer.reviveProjects now requires an alwaysCreateEntryPointModule option.
Comment.serializeDisplayParts no longer requires a serializer argument.
ReflectionSymbolId.fileName is now optional, TypeDoc now stores a combination of a package name and package relative path instead.
The fileName property will be present when initially created, but is not serialized.
Removed DeclarationReflection.relevanceBoost attribute which was added for plugins, but never used.
i18n proxy is no longer passed to many functions, instead, reference i18n exported from the module directly.
ReflectionKind.singularString and ReflectionKind.pluralString now returns translated strings.
The methods on Internationalization to do this previously have been removed.
The HTML output structure for the search box has changed to support the new modal.
DefaultThemeRenderContext's typeDeclaration and typeDetailsIfUseful
methods now require both a reflection and a type in order to support @expandType
Features
Add support for TypeScript 5.8.x
The search modal in the HTML output has been rewritten to provide better mobile support
Added a --router option which can be used to modify TypeDoc's output folder
structure. This can be extended with plugins, #2111.
Introduced the @primaryExport modifier tag to provide more fine grained
control over export conversion order, #2856
Introduced packagesRequiringDocumentation option for validation.notDocumented, TypeDoc will expect comments to be present for symbols in the specified packages.
TypeDoc now exports a typedoc/browser entrypoint for parsing and using serialized JSON files, #2528.
Type packageOptions as Partial<TypeDocOptions>, #2878.
TypeDoc will now warn if an option which should only be set at the root level is set in packageOptions, #2878.
Introduced @function tag to force TypeDoc to convert variable declarations with a type annotation as functions, #2881.
Exposed a TypeDoc global object in the HTML theme which can be used to prevent TypeDoc from using localStorage, #2872.
Introduced @preventInline and @inlineType tags for further control extending the @inline tag, #2862.
Introduced @preventExpand and @expandType tags for further control extending the @expand tag, #2862.
API: Introduced DefaultThemeRenderContext.reflectionIcon for more granular control over displayed reflection icons.
Bug Fixes
TypeDoc will now only create references for symbols re-exported from modules.
Variable-functions will now prefer placing the comment on the signature if there is only one signature present, #2824.
User filter settings will no longer sometimes cause the search to have fewer visible results than expected.
Fixed handling of expando functions which were also merged with a namespace, #2876.
Fixed rendering of function types within arrays and union types, #2892.
Fixed an issue where if the theme JS didn't load, the page wouldn't be shown, #2894.
@includeCode and @inline can now inject parts of files using region
names or line numbers, #2816.
Introduced ja translation options, deprecated jp in favor of ja, #2843.
Improved TypeDoc's --watch option to support watching files not caught by
TypeScript's watch mode, #2675.
The @inline tag now works in more places for generic types.
Visibility filters now consider individual signatures, #2846.
Bug Fixes
Fixed an issue where TypeDoc would incorrectly ignore type arguments in references, #2823.
Improved narrator support for labeling icons, #2832.
Fixed an issue with @class incorrectly handling mapped types, #2842.
TypeDoc will now consider symbols to be external only if all of their declarations are external
so that declaration merged members with global symbols can be documented, #2844.
Fixed an issue where TypeDoc would constantly rebuild, #2844.
Fixed an issue where the dropdown arrow in the index group would not respect the state of the dropdown, #2845.
Possibly Breaking: TypeDoc will no longer render anchors within the page for
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.
TypeDoc will now warn if a property which does not have a URL within the
rendered document and the parent property/page will be linked to instead, #2808. These warnings can be disabled with the validation.rewrittenLink
option.
Fix restoration of groups/categories including documents, #2801.
Fixed missed relative paths within markdown link references in documents.
Improved handling of incomplete inline code blocks within markdown.
Direct https:// links under the hostedBaseUrl option's URL will no
longer be treated as external, #2809.
Convert to ESM to enable easier use of ESM-only dependencies.
Drop support for TypeScript <5.0, no longer supported by DefinitelyTyped
Relaxed requirements for file names and generated url fragments. This may
result in a different file name structure, #2714.
Anchors to document headings and reflections within a HTML generated pages
have changed. They can be partially restored to the previous format by
setting --sluggerConfiguration.lowercase false. This change was made to
more closely match the default behavior of GitHub's markdown rendering and
VSCode's autocomplete when creating a relative link to an external markdown
file.
Removed the hideParameterTypesInTitle option, this was originally added as
a 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.
Changed the default kindSortOrder to put references last.
Changed the default sort order to use alphabetical-ignoring-documents
instead of alphabetical.
Changed default of suppressCommentWarningsInDeclarationFiles to true
API: Constructor signatures now use the parent class name as their name
(e.g. X, not new X)
API: @group, @category, @groupDescription and @categoryDescription
will no longer be removed from the reflections they are present on. They are
skipped during rendering with the notRenderedTags option.
Features
Add support for TypeScript 5.7
TypeDoc will now discover entry points from package.json exports if they
are not provided manually, #1937.
Relative links to markdown files may now include #anchor links to
reference a heading within them.
Improved support for @param comments with nested object types, #2555.
Improved support for @param comments which reference a type
alias/interface. Important properties on the referenced type can now be
highlighted with @param options.foo, which will result in the additional
note 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.
Added a new outputs option which is an array of outputs. This can be used
to render the documentation multiple times with different rendering options
or output types, #2597.
Added support for rendering alerts (or callouts) in markdown.
Add support for an @expand tag which can be placed on type aliases and
interfaces. When a type with @expand is referenced and TypeDoc has a place
to include additional details about the type, the properties of the type
will be included in the page where @expand is found. 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.
Add support for an @inline tag which can be placed on type aliases and
interfaces. When a type with @inline is referenced, TypeDoc will resolve
the 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.
Introduced a new @useDeclaredType tag for type aliases which can sometimes
improve their documentation, #2654.
Added a new @mergeModuleWith tag which can be used to tell TypeDoc to
place a module/namespace's children under a different module/namespace and
remove the real parent, #2281.
Added new @include and @includeCode inline tags to include files within
comments/documents.
Add notRenderedTags option. This option is similar to the excludeTags
option, but while excludeTags will result in the tag being completely
removed from the documentation, notRenderedTags only prevents it from
being included when rendering.
Added groupReferencesByType option.
Added navigation.excludeReferences option
Added useFirstParagraphOfCommentAsSummary option to configure how TypeDoc
handles comments for module members without the @summary tag.
Introduced favicon option to specify a .ico or .svg favicon to reference.
Sections within the page and in the "On This Page" navigation are now tied
together and will expand/collapse together, #2335.
API: Introduced a new app.outputs object for defining new output strategies.
API: TypeDoc's CSS is now wrapped in @layer typedoc, #2782.
Bug Fixes
TypeDoc now properly flags readonly index signatures.
TypeDoc will now use the first signature's comment for later signatures in
overloads if present, #2718.
Fixed handling of @enum if the type was declared before the variable, #2719.
Fixed empty top level modules page in packages mode, #2753.
TypeDoc can now link to type alias properties, #2524.
TypeDoc will now document the merged symbol type when considering globals
declared inside declare global, #2774
TypeDoc now converts declare module "foo" as a module rather than a namespace, #2778.
Import types in type aliases now use module member references if present, #2779.
Fixed an issue where properties were not properly marked optional in some
cases. This primarily affected destructured parameters.
Added yaml to the highlight languages supported by default.
TypeDoc now recognizes txt as an alias of text to indicate a code block
should not be highlighted.
Items which are hidden with @ignore or @hidden but still referenced by
other types will no longer produce warnings about not being exported.
If a project only has one module within it, TypeDoc will now consider that
module when resolving @link tags.
The arrows to indicate whether or not a section is open now work when
JavaScript is disabled.
Group/category search boosts are now applied when writing the search index
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.
Exported constants no longer render the type and default value if they are the same, #2717.
The HTML output now wraps tag blocks with <div> tags and includes the tag name in a class name, #2723.
Bug Fixes
Correctly handle external link resolver link text when referencing an external symbol, #2700.
Big integer literals are now supported as default values, #2721.
Corrected handling of @link tags present in comments at the start of source files.
The index will now display when a module only contains documents, #2722.
ReflectionSymbolId.pos no longer references the position before any doc comments for a symbol.
This could cause typedoc-plugin-dt-links to produce links which didn't go to the expected location in a file.
Use of the @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.
Added new navigation.compactFolders option to prevent TypeDoc from compacting folders, similar to the VSCode option. #2667.
Bug Fixes
The suppressCommentWarningsInDeclarationFiles option now correctly ignores warnings in .d.cts and .d.mts files, #2647.
Restored re-exports in the page navigation menu, #2671.
JSON serialized projects will no longer contain reflection IDs for other projects created in the same run. Gerrit0/typedoc-plugin-zod#6.
In packages mode the reflection ID counter will no longer be reset when converting projects. This previously could result in links to files not working as expected.
Added a --suppressCommentWarningsInDeclarationFiles option to disable warnings from
parsing comments in declaration files, #2611.
Improved comment discovery to more closely match TypeScript's discovery when getting comments
for members of interfaces/classes, #2084, #2545.
Bug Fixes
The text non-highlighted language no longer causes warnings when rendering, #2610.
If a comment on a method is inherited from a parent class, and the child class does not
use an @param tag from the parent, TypeDoc will no longer warn about the @param tag.
Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.
This PR includes no changesets
When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types
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
dependenciesPull requests that update a dependency file
0 participants
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.25.2→0.28.17Release Notes
TypeStrong/TypeDoc (typedoc)
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.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
@group noneand@category nonewill now render their children without a sectionheading in the default theme, #2922.
@disableGroupstag to completely disable the grouping mechanism for agiven reflection, #2922.
Bug Fixes
@classnow correctly handle@category, #2914.@classnow include constructor parameters, #2914.@classwith a generic first constructor function now adoptthat function's type parameters as the class type parameters, #2914.
externalSymbolLinkMappingsoption when URL is set to#, #2921.@typedefnow correctly handle the constraint, #2929.toStringon types containing index signatures now behave correctly, #2917.@inlineTypeto the list of tags excluded by default.v0.28.1Compare 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.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.11Compare Source
Features
hostedBaseUrlis set to the root page on a website, TypeDoc will now includeWebSitestructured data, #2760.Bug Fixes
"module": "ESNext"and importing TypeDoc, #2747.v0.26.10Compare Source
Bug Fixes
v0.26.9Compare Source
Features
headingsoption to control optional headings, #2729.Bug Fixes
externalSymbolLinkMappingsnow uses the TypeScript reported link target if available, #2725.Thanks!
v0.26.8Compare Source
Features
<div>tags and includes the tag name in a class name, #2723.Bug Fixes
@linktags present in comments at the start of source files.ReflectionSymbolId.posno longer references the position before any doc comments for a symbol.This could cause typedoc-plugin-dt-links to produce links which didn't go to the expected location in a file.
Thanks!
v0.26.7Compare Source
Features
customJsoption to include a script tag in generated HTML output, #2650.markdownLinkExternaloption to treathttp[s]://links in markdown documents and comments as external to be opened in a new tab, #2679.navigation.excludeReferencesoption to prevent re-exports from appearing in the left hand navigation, #2685.@abstracttag, #2692.Bug Fixes
@linktags to symbols which are not included in the documentation will produce invalid link warnings again, #2681.@paramtags on comments attached to function callback parameters, #2683.alphabeticalandalphabetical-ignoring-documentssort options now uselocaleCompareto sort, #2684.thisparameter, #2698.Thanks!
v0.26.6Compare Source
Features
@extendsblock 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.compactFoldersoption to prevent TypeDoc from compacting folders, similar to the VSCode option. #2667.Bug Fixes
suppressCommentWarningsInDeclarationFilesoption now correctly ignores warnings in.d.ctsand.d.mtsfiles, #2647.v0.26.5Compare Source
Features
OptionDefaults, #2640.Bug Fixes
@documentincludes an empty file, #2638.Thanks!
v0.26.4Compare Source
Bug Fixes
@linktags will now be validated in referenced markdown documents, #2629.@linktags are now resolved in project documents, #2629.@hiddenis now properly applied when placed in a function implementation comment, #2634.Thanks!
v0.26.3Compare Source
Features
Bug Fixes
mailto:links are no longer incorrectly recognized as relative paths, #2613.@sinceto the default list of recognized tags, #2614.v0.26.2Compare Source
Features
--suppressCommentWarningsInDeclarationFilesoption to disable warnings fromparsing comments in declaration files, #2611.
for members of interfaces/classes, #2084, #2545.
Bug Fixes
textnon-highlighted language no longer causes warnings when rendering, #2610.use an
@paramtag from the parent, TypeDoc will no longer warn about the@paramtag.v0.26.1Compare Source
Features
hostedBaseUrlis set to the root page on a website, TypeDoc will now includeWebSitestructured data, #2760.Bug Fixes
Configuration
📅 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.