-
-
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
chore(deps): update dependency typedoc to v0.27.9 #53
Open
renovate
wants to merge
1
commit into
dev
Choose a base branch
from
renovate/typedoc-0.x
base: dev
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.
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
ca571aa
to
9f8b652
Compare
9f8b652
to
0ad18fe
Compare
0ad18fe
to
3df1570
Compare
3df1570
to
d2a08bb
Compare
d2a08bb
to
d880863
Compare
d880863
to
14cffd4
Compare
14cffd4
to
da19cf4
Compare
da19cf4
to
ea2b64d
Compare
c0cde27
to
bbac00a
Compare
bbac00a
to
42d681e
Compare
42d681e
to
c9a1b44
Compare
c9a1b44
to
80acaf1
Compare
80acaf1
to
f6f9941
Compare
f6f9941
to
1a7b552
Compare
743ae85
to
02fdb89
Compare
02fdb89
to
0b17378
Compare
e444a2a
to
29480b3
Compare
29480b3
to
5ddadfa
Compare
5ddadfa
to
0cde7b6
Compare
0cde7b6
to
802d922
Compare
62fdfa5
to
e915811
Compare
e915811
to
0a331e9
Compare
0a331e9
to
7910528
Compare
7910528
to
2492ccd
Compare
2492ccd
to
c3d2112
Compare
c3d2112
to
d9fb767
Compare
d9fb767
to
c518338
Compare
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.26.4
->0.27.9
Release Notes
TypeStrong/TypeDoc (typedoc)
v0.27.9
Compare Source
This will be the last v0.27.x release, see #2868 for discussion on the 0.28 beta.
Features
v0.27.8
Compare Source
Features
visibilityFilter
option now supports individual signatures, #2846.favicon
option may now be given a link starting withhttps?://
instead of a path, #2851.#
as the link inexternalSymbolLinkMappings
to indicate the type should not be linked to, #2853.Bug Fixes
undefined
, #2854.Thanks!
v0.27.7
Compare Source
Features
@includeCode
and@inline
can now inject parts of files using regionnames or line numbers, #2816.
ja
translation options, deprecatedjp
in favor ofja
, #2843.--watch
option to support watching files not caught byTypeScript's watch mode, #2675.
@inline
tag now works in more places for generic types.Bug Fixes
@class
incorrectly handling mapped types, #2842.so that declaration merged members with global symbols can be documented, #2844.
Thanks!
v0.27.6
Compare Source
Features
ignoredHighlightLanguages
option to specify languages which will beallowed in code blocks but not highlighted, #2819.
Bug Fixes
@include
and@includeCode
now work in the readme file, #2814.same symbol over type literal properties within function parameters.
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!
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.