-
-
Notifications
You must be signed in to change notification settings - Fork 176
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 ^0.26.2 #5076
Conversation
This pull request is automatically built and testable in CodeSandbox. To see build info of the built libraries, click here or the icon next to each commit SHA. Latest deployment of this branch, based on commit 21926b2:
|
👋 A preview of the new documentation is available at: http://667629fc543aae1f21ed73b5--dubzzz-fast-check.netlify.app |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #5076 +/- ##
=======================================
Coverage 96.89% 96.89%
=======================================
Files 215 215
Lines 16384 16384
Branches 2662 2670 +8
=======================================
Hits 15875 15875
Misses 509 509
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
67628fc
to
e7e3b93
Compare
👋 A preview of the new documentation is available at: http://66777513b32e3b28a9777896--dubzzz-fast-check.netlify.app |
e7e3b93
to
c06f3ac
Compare
👋 A preview of the new documentation is available at: http://6678ffedb8e00c38f6986408--dubzzz-fast-check.netlify.app |
c06f3ac
to
21926b2
Compare
👋 A preview of the new documentation is available at: http://66792884faf0e2711b0f7a35--dubzzz-fast-check.netlify.app |
This PR contains the following updates:
^0.25.13
->^0.26.2
Release Notes
TypeStrong/TypeDoc (typedoc)
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!
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 has been generated by Mend Renovate. View repository job log here.