-
Notifications
You must be signed in to change notification settings - Fork 1
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update dependency typedoc to v0.27.5 #20
Open
renovate
wants to merge
1
commit into
master
Choose a base branch
from
renovate/typedoc-0.x
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Conversation
This file contains 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
renovate
bot
force-pushed
the
renovate/typedoc-0.x
branch
2 times, most recently
from
February 18, 2018 23:31
27ee7dd
to
2a567d8
Compare
renovate
bot
force-pushed
the
renovate/typedoc-0.x
branch
from
March 5, 2018 07:10
2a567d8
to
dd66886
Compare
renovate
bot
changed the title
Update dependency typedoc to v0.10.0
Update dependency typedoc to v0.11.0
Mar 5, 2018
renovate
bot
force-pushed
the
renovate/typedoc-0.x
branch
from
March 9, 2018 05:09
dd66886
to
810f8d9
Compare
renovate
bot
changed the title
Update dependency typedoc to v0.11.0
Update dependency typedoc to v0.11.1
Mar 9, 2018
renovate
bot
force-pushed
the
renovate/typedoc-0.x
branch
from
August 17, 2018 18:53
810f8d9
to
448eed4
Compare
renovate
bot
changed the title
Update dependency typedoc to v0.11.1
Update dependency typedoc to v0.12.0
Aug 17, 2018
renovate
bot
changed the title
Update dependency typedoc to v0.12.0
Update dependency typedoc to v0.13.0
Oct 10, 2018
renovate
bot
force-pushed
the
renovate/typedoc-0.x
branch
from
October 10, 2018 14:56
448eed4
to
d4e1c94
Compare
renovate
bot
changed the title
Update dependency typedoc to v0.13.0
Update dependency typedoc to v0.14.0
Jan 3, 2019
renovate
bot
force-pushed
the
renovate/typedoc-0.x
branch
from
January 3, 2019 06:52
d4e1c94
to
85c8dfe
Compare
renovate
bot
force-pushed
the
renovate/typedoc-0.x
branch
from
January 11, 2019 01:37
85c8dfe
to
9c43f33
Compare
renovate
bot
changed the title
Update dependency typedoc to v0.14.0
Update dependency typedoc to v0.14.1
Jan 11, 2019
renovate
bot
force-pushed
the
renovate/typedoc-0.x
branch
from
January 16, 2019 17:53
9c43f33
to
2540495
Compare
renovate
bot
changed the title
Update dependency typedoc to v0.14.1
Update dependency typedoc to v0.14.2
Jan 16, 2019
renovate
bot
force-pushed
the
renovate/typedoc-0.x
branch
from
August 10, 2019 11:56
2540495
to
1fd1ea2
Compare
renovate
bot
changed the title
Update dependency typedoc to v0.14.2
Update dependency typedoc to v0.15.0
Aug 10, 2019
renovate
bot
force-pushed
the
renovate/typedoc-0.x
branch
from
November 21, 2019 13:16
1fd1ea2
to
14d459e
Compare
renovate
bot
changed the title
Update dependency typedoc to v0.15.0
Update dependency typedoc to v0.15.2
Nov 21, 2019
renovate
bot
force-pushed
the
renovate/typedoc-0.x
branch
from
December 14, 2019 21:54
14d459e
to
88df45b
Compare
renovate
bot
changed the title
Update dependency typedoc to v0.15.2
Update dependency typedoc to v0.15.4
Dec 14, 2019
renovate
bot
force-pushed
the
renovate/typedoc-0.x
branch
from
December 22, 2019 00:59
88df45b
to
2018832
Compare
renovate
bot
changed the title
Update dependency typedoc to v0.15.4
Update dependency typedoc to v0.15.5
Dec 22, 2019
renovate
bot
force-pushed
the
renovate/typedoc-0.x
branch
from
December 31, 2019 19:00
2018832
to
abde220
Compare
renovate
bot
changed the title
Update dependency typedoc to v0.15.5
Update dependency typedoc to v0.15.6
Dec 31, 2019
renovate
bot
force-pushed
the
renovate/typedoc-0.x
branch
from
January 18, 2020 18:59
abde220
to
d7521b3
Compare
renovate
bot
changed the title
Update dependency typedoc to v0.15.6
Update dependency typedoc to v0.16.7
Jan 18, 2020
renovate
bot
force-pushed
the
renovate/typedoc-0.x
branch
from
February 8, 2020 15:53
d7521b3
to
a27d949
Compare
renovate
bot
changed the title
Update dependency typedoc to v0.16.7
Update dependency typedoc to v0.16.9
Feb 8, 2020
renovate
bot
changed the title
Update dependency typedoc to v0.26.2
Update dependency typedoc to v0.26.3
Jun 28, 2024
renovate
bot
force-pushed
the
renovate/typedoc-0.x
branch
from
July 10, 2024 07:00
e48eeba
to
83b4cfc
Compare
renovate
bot
changed the title
Update dependency typedoc to v0.26.3
Update dependency typedoc to v0.26.4
Jul 10, 2024
renovate
bot
force-pushed
the
renovate/typedoc-0.x
branch
from
July 21, 2024 18:59
83b4cfc
to
4d9e920
Compare
renovate
bot
changed the title
Update dependency typedoc to v0.26.4
Update dependency typedoc to v0.26.5
Jul 21, 2024
renovate
bot
force-pushed
the
renovate/typedoc-0.x
branch
from
August 18, 2024 18:50
4d9e920
to
22d9d5c
Compare
renovate
bot
changed the title
Update dependency typedoc to v0.26.5
Update dependency typedoc to v0.26.6
Aug 18, 2024
renovate
bot
force-pushed
the
renovate/typedoc-0.x
branch
from
September 9, 2024 01:37
22d9d5c
to
f68a81d
Compare
renovate
bot
changed the title
Update dependency typedoc to v0.26.6
Update dependency typedoc to v0.26.7
Sep 9, 2024
renovate
bot
force-pushed
the
renovate/typedoc-0.x
branch
from
October 4, 2024 18:11
f68a81d
to
c015a14
Compare
renovate
bot
changed the title
Update dependency typedoc to v0.26.7
Update dependency typedoc to v0.26.8
Oct 4, 2024
renovate
bot
force-pushed
the
renovate/typedoc-0.x
branch
from
October 11, 2024 18:38
c015a14
to
12e6735
Compare
renovate
bot
changed the title
Update dependency typedoc to v0.26.8
Update dependency typedoc to v0.26.9
Oct 11, 2024
renovate
bot
force-pushed
the
renovate/typedoc-0.x
branch
from
October 16, 2024 08:52
12e6735
to
dfaaebe
Compare
renovate
bot
changed the title
Update dependency typedoc to v0.26.9
Update dependency typedoc to v0.26.10
Oct 16, 2024
renovate
bot
force-pushed
the
renovate/typedoc-0.x
branch
from
November 1, 2024 18:40
dfaaebe
to
228d5c9
Compare
renovate
bot
changed the title
Update dependency typedoc to v0.26.10
Update dependency typedoc to v0.26.11
Nov 1, 2024
renovate
bot
force-pushed
the
renovate/typedoc-0.x
branch
from
November 27, 2024 03:55
228d5c9
to
5ed03c9
Compare
renovate
bot
changed the title
Update dependency typedoc to v0.26.11
Update dependency typedoc to v0.27.0
Nov 27, 2024
renovate
bot
force-pushed
the
renovate/typedoc-0.x
branch
from
November 28, 2024 01:56
5ed03c9
to
3279057
Compare
renovate
bot
changed the title
Update dependency typedoc to v0.27.0
Update dependency typedoc to v0.27.1
Nov 28, 2024
renovate
bot
force-pushed
the
renovate/typedoc-0.x
branch
from
November 30, 2024 01:47
3279057
to
4aba50d
Compare
renovate
bot
changed the title
Update dependency typedoc to v0.27.1
Update dependency typedoc to v0.27.2
Nov 30, 2024
renovate
bot
force-pushed
the
renovate/typedoc-0.x
branch
from
December 4, 2024 07:17
4aba50d
to
9aed684
Compare
renovate
bot
changed the title
Update dependency typedoc to v0.27.2
Update dependency typedoc to v0.27.3
Dec 4, 2024
renovate
bot
force-pushed
the
renovate/typedoc-0.x
branch
from
December 9, 2024 02:21
9aed684
to
1aa8606
Compare
renovate
bot
changed the title
Update dependency typedoc to v0.27.3
Update dependency typedoc to v0.27.4
Dec 9, 2024
renovate
bot
force-pushed
the
renovate/typedoc-0.x
branch
from
December 14, 2024 18:25
1aa8606
to
65ad66e
Compare
renovate
bot
changed the title
Update dependency typedoc to v0.27.4
Update dependency typedoc to v0.27.5
Dec 14, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
None yet
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.9.0
->0.27.5
Release Notes
TypeStrong/TypeDoc (typedoc)
v0.27.5
Compare 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.rewrittenLink
option.
https://
links under thehostedBaseUrl
option's URL will nolonger be treated as external, #2809.
Thanks!
v0.27.4
Compare Source
Features
Converter.EVENT_CREATE_PROJECT
event which fires when a project is created by the converter, #2800.Bug Fixes
@include
and@includeCode
now work for comments on the entry point for projects with a single entry point, #2800.@summary
now works to describe functions within modules, #2803.v0.27.3
Compare Source
Features
Bug Fixes
highlightLanguages
option now permits Shiki aliases to be specified rather than just the language ID, #2798.Thanks!
v0.27.2
Compare Source
Bug Fixes
v0.27.1
Compare Source
Bug Fixes
@categoryDescription
and@groupDescription
on module pages, #2787.v0.27.0
Compare 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.
hideParameterTypesInTitle
option, 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.
kindSortOrder
to put references last.sort
order to usealphabetical-ignoring-documents
instead of
alphabetical
.suppressCommentWarningsInDeclarationFiles
totrue
(e.g.
X
, notnew X
)@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
package.json
exports if theyare not provided manually, #1937.
#anchor
links toreference a heading within them.
@param
comments with nested object types, #2555.@param
comments 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.
outputs
option which is an array of outputs. This can be usedto render the documentation multiple times with different rendering options
or output types, #2597.
@expand
tag which can be placed on type aliases andinterfaces. When a type with
@expand
is referenced and TypeDoc has a placeto 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 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.
@inline
tag which can be placed on type aliases andinterfaces. When a type with
@inline
is 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.
@useDeclaredType
tag for type aliases which can sometimesimprove their documentation, #2654.
@mergeModuleWith
tag which can be used to tell TypeDoc toplace a module/namespace's children under a different module/namespace and
remove the real parent, #2281.
@include
and@includeCode
inline tags to include files withincomments/documents.
notRenderedTags
option. This option is similar to theexcludeTags
option, but while
excludeTags
will result in the tag being completelyremoved from the documentation,
notRenderedTags
only prevents it frombeing included when rendering.
groupReferencesByType
option.navigation.excludeReferences
optionuseFirstParagraphOfCommentAsSummary
option to configure how TypeDochandles comments for module members without the
@summary
tag.favicon
option to specify a.ico
or.svg
favicon to reference.together and will expand/collapse together, #2335.
app.outputs
object for defining new output strategies.@layer typedoc
, #2782.Bug Fixes
readonly
index signatures.overloads if present, #2718.
@enum
if 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.
yaml
to the highlight languages supported by default.txt
as an alias oftext
to indicate a code blockshould not be highlighted.
@ignore
or@hidden
but still referenced byother types will no longer produce warnings about not being exported.
module when resolving
@link
tags.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
Compare Source
Features
hostedBaseUrl
is set to the root page on a website, TypeDoc will now includeWebSite
structured data, #2760.Bug Fixes
"module": "ESNext"
and importing TypeDoc, #2747.v0.26.10
Compare Source
Bug Fixes
v0.26.9
Compare Source
Features
headings
option to control optional headings, #2729.Bug Fixes
externalSymbolLinkMappings
now uses the TypeScript reported link target if available, #2725.Thanks!
v0.26.8
Compare Source
Features
<div>
tags and includes the tag name in a class name, #2723.Bug Fixes
@link
tags present in comments at the start of source files.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.
Thanks!
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.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.