Skip to content
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-plugin-markdown to v4 #222

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented May 3, 2024

Mend Renovate

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
typedoc-plugin-markdown (source) 3.17.1 -> 4.2.3 age adoption passing confidence

Release Notes

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

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

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.
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)

Earlier changelog entries can be found in CHANGELOG_ARCHIVE.md.


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.


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

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

@renovate renovate bot requested a review from Pandapip1 as a code owner May 3, 2024 15:10
Copy link

socket-security bot commented May 3, 2024

New and removed dependencies detected. Learn more about Socket for GitHub ↗︎

Package New capabilities Transitives Size Publisher
npm/typedoc-plugin-markdown@4.2.3 filesystem Transitive: environment +16 15.5 MB tgreyuk

🚮 Removed packages: npm/typedoc-plugin-markdown@3.17.1

View full report↗︎

@renovate renovate bot force-pushed the renovate/typedoc-plugin-markdown-4.x branch from b480073 to eb5d6cb Compare May 7, 2024 02:25
@renovate renovate bot force-pushed the renovate/typedoc-plugin-markdown-4.x branch from eb5d6cb to 141f3de Compare May 16, 2024 01:03
@renovate renovate bot force-pushed the renovate/typedoc-plugin-markdown-4.x branch from 141f3de to 5504f2c Compare May 27, 2024 13:08
@renovate renovate bot force-pushed the renovate/typedoc-plugin-markdown-4.x branch from 5504f2c to 93074f5 Compare June 22, 2024 13:45
@renovate renovate bot force-pushed the renovate/typedoc-plugin-markdown-4.x branch from 93074f5 to 1fbfd87 Compare June 30, 2024 21:56
@renovate renovate bot force-pushed the renovate/typedoc-plugin-markdown-4.x branch 3 times, most recently from 787af61 to 0fe4d70 Compare July 11, 2024 22:05
@renovate renovate bot force-pushed the renovate/typedoc-plugin-markdown-4.x branch from 0fe4d70 to b3bee8c Compare July 22, 2024 20:51
@renovate renovate bot force-pushed the renovate/typedoc-plugin-markdown-4.x branch from b3bee8c to c8f2df1 Compare July 24, 2024 20:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

0 participants