⬆️ Updates typedoc-plugin-markdown to v4 #578

renovate · 2024-05-04T14:32:10Z

This PR contains the following updates:

Package	Change	Age	Adoption	Passing	Confidence
typedoc-plugin-markdown (source)	`^1.2.1` -> `^4.0.0`

Release Notes

typedoc2md/typedoc-plugin-markdown (typedoc-plugin-markdown)

`v4.2.6`

Compare Source

Patch Changes

Expose missing entrypoints to navigation (#663)
Fix missing function descriptions in indexes

`v4.2.5`

Compare Source

Patch Changes

Expose comment for arrow functions in type declarations (#670)
Tables generated with the "htmlTable" key will include <thead> and <tbody> elements to fix MDX compatibility issues (#671)
Expose missing descriptions with accessor keyword (#664)

`v4.2.4`

Compare Source

Patch Changes

Expose comments to reflections with the accessor keyword (#664)
Omit constructors from category groups (#661)
Update categories structure in navigation to match interface model

`v4.2.3`

Compare Source

Patch Changes

Fix missing return comments for const functions (#656)

`v4.2.2`

Compare Source

Patch Changes

Correctly resolve comment summary for const functions (#656)
Fix anchor links containing generics (#655)

`v4.2.1`

Compare Source

Patch Changes

Fix missing index descriptions for signatures (#618)

`v4.2.0`

Compare Source

Minor Changes

Exposed "modulesFileName" option (#647)
Write .nojekyll file if TypeDocs "githubPages" option is true (#650)
Exposed "blockTagsPreserveOrder" option to configure ordering of comment block tags (#627).
Exposed "useHTMLEncodedBrackets" option for alternative angle bracket escaping(#564).

`v4.1.2`

Compare Source

Patch Changes

Support TypeDoc 0.26 relative links implementation (#645).

`v4.1.1`

Compare Source

Patch Changes

Normalize window paths when "publicPath" is set (#639)

`v4.1.0`

Compare Source

New Features

Theme support for TypeDoc’s 0.26 localization model.
Theme support for TypeDoc’s 0.26 documents implementation.
Exposed a new key "htmlTable" to formatting options enabling block elements to render as intended inside table cells. Affects all existing formatting options. Fixes (#618).
Added new formatting options --classPropertiesFormat, --interfacePropertiesFormat and --propertyMembersFormat to further control formatting of different declaration structures.
Supports the ability to control what table columns are rendered with the --tableColumnSettings option.

Patch Changes

Handle duplicate files when tagged in same group (#625)
Fix issues with tables and block tags (#618)

`v4.0.3`

Compare Source

Patch Changes

Remove superfluous quotes from prop names (#619)
Fix display of index descriptions in tables (#618)

`v4.0.2`

Compare Source

Patch Changes

Fix symbol url anchors when "flattenOutputFiles" is "true" (#616)
Normalize line breaks and tags within table columns (#615)
Remove superfluous spaces and symbol on external links (#614)
Escape all angle brackets with "santizeComments" (#612)
Correctly handle quoted symbol names (#611)
Correctly handle excludeScopesInPaths in windows (#610)

`v4.0.1`

Compare Source

Patch Changes

Remove superfluous newlines from table column descriptions (#591).
Handle multiple @example tags on same reflection.
Fix missing extended by definitions.
Escape Symbols with signatures correctly.

`v4.0.0`

Compare Source

v4 is a major release that includes a number of bug fixes, new features and UI improvements.

Architectural Changes

Handlebars as a dependency has been removed.
Updated customization model with the ability to set hooks, events and custom theming.
Exposed navigation structure.

New Features

Updated output file structure.
Improved and cleaner UI.
A set of updated and additional new options with comprehensive documentation.
Exported option types and JSON schema.

Structural Changes

Each module member is now output to its own file by default. See option --outputFileStrategy. To achieve the same output as v3 (whereby only Classes, Enums and Interfaces have their own file), set the option membersWithOwnFile option.
Parameters are output as a list by default. To achieve the same output as v3 (where parameters are output as a table), use option --parametersFormat=table.

Breaking Changes

Because the file structure has changed you may need to update any cross references to files in your documentation.
Setting theme to "markdown" is no longer required and should be removed.
The option indexTitle has been removed. Please use the "title.indexPage" key with option --textContentMappings.
The option allReflectionsHaveOwnDocument has been removed (this behaviour is now the default). Please see option outputFileStrategy](/docs/options#outputfilestrategy).
The option entryDocument has been renamed to entryFileName to better reflect its purpose.
The option namedAnchors has been renamed to useHTMLAnchors to better reflect its purpose.
The option hideInPageTOC has been removed. In-page TOC are no longer included by default. You can include in-page TOCs by using typedoc-plugin-remark and the remark-toc plugin.
The option objectLiteralTypeDeclarationStyle has been removed. Please use option --typeDeclarationFormat=list.

Bug Fixes

Duplication in callback/callable/function properties. (#581).
@experimental / @internal annotations. (#556)
Fix events output and strike-through deprecated items. (#534)
Class static functions are no longer marked. (#533)
@example block not rendered with Headline (#501)
Support for categories (#499)
Correctly resolve package readme urls from member pages. (#483)
Add the ability to add a separate frontmatter for readme file. (#469)
Items in tables are not linkable. (#463)
Custom i18n texts. (#458)
How to improve the formatting for types?. (#456)
How to change title format. (#450)
Export Docusaurus plugin options type. (#440)
How to export interface as a table. (#403)
Broken Link caused by Typescript class being defined in an index file. (#402)
Markdown plugin inserts unnecessary escape characters. (#398)
Potential bug with optional function argument. (#396)
Respect monorepo readmeFile configuration (#383)
Embed all objects under a Module/Namespace onto single page. (#338)
Extra spaces when merging lines in a table. (#331)
Does not support namespace (or module) and interface with same name. (#300)
Integration with VitePress? (#287)
Typedoc comments with text wrapped in < and > breaks Docusaurus Markdown parser. (#276)
Navigation support? (#262)
Sidebar Category Support? (#213)
Properties as Table like function properties. (#109)
Provide a link/excerpt/screenshot to a demo/example rendered output (#102)

`v3.17.1`

Compare Source

Prevent escaping of angle brackets in toc (#495)

`v3.17.0`

Compare Source

Features

Support MDXv2

`v3.16.0`

Compare Source

TypeDoc 0.25.0 compatibility fixes

`v3.15.4`

Compare Source

Fixes

Split out comment summary and tags for signatures (#451) .

Features

TypdeDoc 0.24 compatibility fixes.

`v3.14.0`

Compare Source

Features

Add objectLiteralTypeDeclarationStyle option (#362)
Beautify parameter table output of destructured params (#364)

Fixes

Fix missing descriptions for function params (#357)
Add conditional check to signature comments (#368)

`v3.13.6`

Compare Source

Fixes

Replace deprecated 'attemptExternalResolution' (#344)

`v3.13.5`

Compare Source

Fixes

Export media and includes options (#340)

`v3.13.4`

Compare Source

Fixes

Support @typeParam comments (#326 )

`v3.13.3`

Compare Source

`v3.13.2`

Compare Source

Fixes

Correctly display accessors in type declaration (#320)
Add new line after tags (#324)
Expose values to enums (#323)

`v3.13.1`

Compare Source

`v3.13.0`

Compare Source

Features

TypeDoc 0.23 compatibility fixes (f39318e)

`v3.12.1`

Compare Source

Bug Fixes

Handle non-unique anchor ids (update) (#303) (2deb7b7)

`v3.12.0`

Compare Source

Bug Fixes

Handle non-unique anchor ids (#303) (787748f)

Features

Expose preserveAnchorCasing option (#301) (f51ff45)

`v3.11.14`

Compare Source

Bug Fixes

wrap index signature output within back ticks (#292) (2226322)

`v3.11.13`

Compare Source

Bug Fixes

escape pipes in comments and expand object type in props table (#286) (b87c250)

`v3.11.12`

Compare Source

Bug Fixes

Fixed external resolution reference (#283) (ba935c9)

`v3.11.11`

Compare Source

Bug Fixes

Add comments for function type properties (#281) (d3441f2)

`v3.11.10`

Compare Source

Bug Fixes

Add comments for function type properties (#281) (c38a095)
Correctly define theme using TypeDoc defineTheme method (5f2ef42)

`v3.11.9`

Compare Source

Bug Fixes

expose missing namedAnchors option (regression) (#277) (5353334)
watch mode compatibility (#279) (da65f74)

`v3.11.8`

Compare Source

Bug Fixes

fixed linked resolution (#274)

`v3.11.7`

Compare Source

Bug Fixes

expand generic object (#268) (5029a85)

`v3.11.6`

Compare Source

Bug Fixes

catch all external references (003cb96)
fix type params with default values in params table (7d73eff)

`v3.11.5`

Compare Source

Bug Fixes

Expose 'includes' and 'media' options (regression) (#264) (435e0d2)

`v3.11.4`

Compare Source

Bug Fixes

Added support for third party symbols (#263) (e5a40d5)

`v3.11.3`

Compare Source

Bug Fixes

correctly render references (#254) (32ce13a)

`v3.11.2`

Compare Source

Bug Fixes

remove leading underscore from file names (#248) (bb5e4e3)

`v3.11.1`

Compare Source

Bug Fixes

fix allReflectionsHaveOwnDocument option (64376e9)
properly escape chars inside anchors (d4e5b1d)

`v3.11.0`

Compare Source

Features

TypeDoc 0.22 compatibility fixes (#249) (963250c)

`v3.10.4`

Compare Source

Bug Fixes

Fix anonymous function types in params table (0047faf)

`v3.10.3`

Compare Source

Bug Fixes

Handle TypeDoc 0.21.3 options breaking change (2d0e7b5)

`v3.10.2`

Compare Source

Bug Fixes

Fix string escape inside backticks (3b8ab18)

`v3.10.1`

Compare Source

Bug Fixes

Improve type params table readability (52038e2)
Use backticks for generics and refernce types to improve consistency (#239) (1b3395f)

`v3.10.0`

Compare Source

Features

TypeDoc 0.21 compatibility (fa5e913)

`v3.9.0`

Compare Source

Features

UI fixes and readability enhancements (#230) (f4329a9)

`v3.8.2`

Compare Source

Bug Fixes

Escape leading quote in front-matter string (#228) (ec38cbc)

`v3.8.1`

Compare Source

Bug Fixes

Escape double quotes inside Front Matter yaml string (8ce2f2b)
Fix duplicate source blocks (616ca4e)

`v3.8.0`

Compare Source

Bug Fixes

Add space between 'Const' and signature name (#220) (9400803)

Features

Enforce markdowninit standards (#219) (76a90bb)
Improve heading structure with disabled inline toc (#222) (2e898ac)

`v3.7.2`

Compare Source

Bug Fixes

Escape inherited types (#215) (34c5e7b)

`v3.7.1`

Compare Source

Bug Fixes

Remove extraneous whitespace in table description col (4e56ae4)

`v3.7.0`

Compare Source

Features

Prefix table bars to beggining of lines
Use backticks and quote strings for literal types

`v3.6.1`

Compare Source

`v3.6.0`

Compare Source

Bug Fixes

Expand signature return types. (a348f53)

Features

Added --hidePageTitle option (0b9588b)
Added Front matter utils (a530828)

`v3.5.0`

Compare Source

`v3.4.5`

Compare Source

`v3.4.4`

Compare Source

`v3.4.3`

Compare Source

`v3.4.2`

Compare Source

`v3.4.1`

Compare Source

`v3.4.0`

Compare Source

`v3.3.0`

Compare Source

Added entryDocument option - fixes #176

`v3.2.1`

Compare Source

`v3.2.0`

Compare Source

Support for TypeDoc 0.20
Minor ui tweaks

`v3.1.1`

Compare Source

`v3.1.0`

Compare Source

`v3.0.11`

Compare Source

`v3.0.10`

Compare Source

`v3.0.9`

Compare Source

`v3.0.8`

Compare Source

`v3.0.7`

Compare Source

`v3.0.6`

Compare Source

`v3.0.5`

Compare Source

`v3.0.4`

Compare Source

`v3.0.3`

Compare Source

`v3.0.2`

Compare Source

`v3.0.1`

Compare Source

`v3.0.0`

Compare Source

[breaking change] Removed --theme docusaurus/vuepress implementation in favour of seperate plugins.
- docusaurus-plugin-typedoc
- vuepress-plugin-typedoc
Implementation of some subtle UI tweaks to improve readability.
Fixed issues with missing types and reflections.
Updated object literals/type literals to display props/params in a tabular format.

`v2.4.2`

Compare Source

`v2.4.1`

Compare Source

`v2.4.0`

Compare Source

Added publicPath option
Fixed array of union types being rendered without parentheses #130

`v2.3.2`

Compare Source

Replace angle brackets with pointing angles #136

`v2.3.1`

Compare Source

Merged #127

`v2.3.0`: v.2.3.0

Compare Source

fixed #119
merged #124

`v2.2.17`

Compare Source

Merged #108 (option to skip sidebar)

`v2.2.16`

Compare Source

`v2.2.15`

Compare Source

`v2.2.14`

Compare Source

`v2.2.13`

Compare Source

`v2.2.12`

Compare Source

`v2.2.11`

Compare Source

Implement index hiding #106

`v2.2.10`

Compare Source

`v2.2.9`

Compare Source

`v2.2.8`

Compare Source

`v2.2.7`

Compare Source

`v2.2.6`

Compare Source

Merged #98

`v2.2.5`

Compare Source

Fixed #97

`v2.2.4`

Compare Source

Fixed #95

`v2.2.3`

Compare Source

Merged #94

`v2.2.2`

Compare Source

`v2.2.1`

Compare Source

`v2.2.0`

Compare Source

Updated theming model
Support for categorization

`v2.1.12`

Compare Source

`v2.1.11`

Compare Source

`v2.1.10`

Compare Source

`v2.1.9`

Compare Source

`v2.1.8`

Compare Source

`v2.1.7`

Compare Source

`v2.1.6`

Compare Source

`v2.1.5`

Compare Source

`v2.1.4`

Compare Source

`v2.1.3`

Compare Source

Fixed #77 symbol references

`v2.1.2`

Compare Source

`v2.1.1`

[Compare Source](https://togithub.com/typedoc2md/typedoc-plugin-markdown

Configuration

📅 Schedule: Branch creation - "after 10pm every weekday,before 5am every weekday,every weekend" in timezone Europe/Moscow, Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

♻ Rebasing: Whenever PR is behind base branch, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.

If you want to rebase/retry this PR, check this box

This PR was generated by Mend Renovate. View the repository job log.

Signed-off-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

renovate · 2024-05-04T14:32:11Z

⚠ Artifact update problem

Renovate failed to update an artifact related to this branch. You probably do not want to merge this PR as-is.

♻ Renovate will retry this branch, including artifacts, only when one of the following happens:

any of the package files in this branch needs updating, or
the branch becomes conflicted, or
you click the rebase/retry checkbox if found above, or
you rename this PR's title to start with "rebase!" to trigger it manually

The artifact failure details are included below:

File name: package-lock.json

npm ERR! code ERESOLVE
npm ERR! ERESOLVE unable to resolve dependency tree
npm ERR! 
npm ERR! While resolving: [email protected]
npm ERR! Found: [email protected]
npm ERR! node_modules/typedoc
npm ERR!   dev typedoc@"^0.20.36" from the root project
npm ERR! 
npm ERR! Could not resolve dependency:
npm ERR! peer typedoc@"0.25.x" from [email protected]
npm ERR! node_modules/typedoc-plugin-markdown
npm ERR!   dev typedoc-plugin-markdown@"^4.0.0" from the root project
npm ERR! 
npm ERR! Fix the upstream dependency conflict, or retry
npm ERR! this command with --force, or --legacy-peer-deps
npm ERR! to accept an incorrect (and potentially broken) dependency resolution.
npm ERR! 
npm ERR! See /tmp/renovate/cache/others/npm/eresolve-report.txt for a full report.

npm ERR! A complete log of this run can be found in:
npm ERR!     /tmp/renovate/cache/others/npm/_logs/2024-05-04T14_31_59_528Z-debug-0.log

github-actions · 2024-05-04T14:32:33Z

Thanks for the PR!

This section of the codebase is owner by https://github.com/AlexRogalskiy/ - if they write a comment saying "LGTM" then it will be merged.

github-actions · 2024-05-04T14:32:37Z

Thanks for opening an issue! Make sure you've followed CONTRIBUTING.md.

github-actions · 2024-05-04T14:32:38Z

Hello from PR Helper

Is your PR ready for review and processing? Mark the PR ready by including #pr-ready in a comment.

If you still have work to do, even after marking this ready. Put the PR on hold by including #pr-onhold in a comment.

github-actions

Scan Summary

Tool	Critical	High	Medium	Low	Status
Dependency Scan (universal)	2	22	7	0	❌
Security Audit for Infrastructure	0	0	0	3	✅

Recommendation

Please review the findings from Code scanning alerts before approving this pull request. You can also configure the build rules or add suppressions to customize this bot 👍

⬆️ Updates typedoc-plugin-markdown to v4

d958d48

Signed-off-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

renovate bot added the npm dependencies label May 4, 2024

auto-assign bot requested a review from AlexRogalskiy May 4, 2024 14:32

github-actions bot added the review-required label May 4, 2024

github-actions bot reviewed May 4, 2024

View reviewed changes

github-actions bot added the security findings label May 4, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

⬆️ Updates typedoc-plugin-markdown to v4 #578

⬆️ Updates typedoc-plugin-markdown to v4 #578

renovate bot commented May 4, 2024 •

edited

Loading

renovate bot commented May 4, 2024

github-actions bot commented May 4, 2024

github-actions bot commented May 4, 2024

github-actions bot commented May 4, 2024

github-actions bot left a comment

⬆️ Updates typedoc-plugin-markdown to v4 #578

Are you sure you want to change the base?

⬆️ Updates typedoc-plugin-markdown to v4 #578

Conversation

renovate bot commented May 4, 2024 • edited Loading

Release Notes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Minor Changes

Patch Changes

Patch Changes

New Features

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Architectural Changes

New Features

Structural Changes

Breaking Changes

Bug Fixes

Features

Fixes

Features

Features

Fixes

Fixes

Fixes

Fixes

Fixes

Features

Bug Fixes

Bug Fixes

Features

Bug Fixes

Bug Fixes

Bug Fixes

Bug Fixes

Bug Fixes

Bug Fixes

Bug Fixes

Bug Fixes

Bug Fixes

Bug Fixes

Bug Fixes

Bug Fixes

Bug Fixes

Bug Fixes

Features

Bug Fixes

Bug Fixes

Bug Fixes

Bug Fixes

Features

Features

Bug Fixes

Bug Fixes

Bug Fixes

Features

Bug Fixes

Bug Fixes

Features

Bug Fixes

Features

renovate bot commented May 4, 2024 •

edited

Loading