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.

Sign up for GitHub

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

Jump to bottom

chore(deps): update dependency typedoc-plugin-markdown to v4 #6137

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

chore(deps): update dependency typedoc-plugin-markdown to v4 #6137

wants to merge 1 commit into from

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented May 3, 2024 •
edited
Loading

This PR contains the following updates:

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

Release Notes

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

v4.2.10

Compare Source

Patch Changes
  • Enhanced the formatting and structure of accessor output (#​711)

v4.2.9

Compare Source

Patch Changes
  • Expose @return block tags on declarations (#​694)
  • Add parentheses on function names in type declaration table views (#​696)

v4.2.8

Compare Source

Patch Changes
  • Fix missing slash when public path is prefixed with http (#​688)

v4.2.7

Compare Source

Patch Changes
  • Correctly handle top level custom groups in navigation (#​685)
  • Fix missing index descriptions for some signatures (#​670)
  • Add '?' for optional type declarations in tables

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

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 added the dependencies Pull requests that update a dependency file label May 3, 2024
@changeset-bot changeset-bot
Copy link

changeset-bot bot commented May 3, 2024 •
edited
Loading

⚠️ No Changeset found

Latest commit: 9929fb9

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@renovate renovate bot force-pushed the renovate/typedoc-plugin-markdown-4.x branch from 6a0d838 to 0c7b334 Compare May 7, 2024 01:27
@renovate renovate bot force-pushed the renovate/typedoc-plugin-markdown-4.x branch from 0c7b334 to 42a0724 Compare May 15, 2024 22:04
@renovate renovate bot force-pushed the renovate/typedoc-plugin-markdown-4.x branch from 42a0724 to 6c25814 Compare May 27, 2024 12:19
@renovate renovate bot force-pushed the renovate/typedoc-plugin-markdown-4.x branch 2 times, most recently from 9311436 to 4c3f6e1 Compare June 24, 2024 19:06
@renovate renovate bot force-pushed the renovate/typedoc-plugin-markdown-4.x branch 2 times, most recently from 876740e to e0f1269 Compare July 5, 2024 14:55
@renovate renovate bot force-pushed the renovate/typedoc-plugin-markdown-4.x branch 2 times, most recently from 21a2a4a to a0084ff Compare July 11, 2024 23:19
@renovate renovate bot force-pushed the renovate/typedoc-plugin-markdown-4.x branch 2 times, most recently from 81ff6f3 to 3862dd0 Compare July 24, 2024 22:21
@ardatan ardatan force-pushed the master branch 5 times, most recently from d34fb65 to b8bf584 Compare August 11, 2024 23:45
@renovate renovate bot force-pushed the renovate/typedoc-plugin-markdown-4.x branch 4 times, most recently from adbb1ea to a92e407 Compare August 16, 2024 01:56
@renovate renovate bot force-pushed the renovate/typedoc-plugin-markdown-4.x branch from a92e407 to 13d7480 Compare August 25, 2024 10:11
@renovate renovate bot force-pushed the renovate/typedoc-plugin-markdown-4.x branch 2 times, most recently from 55cfd14 to 7b8329e Compare September 5, 2024 22:40
@renovate renovate bot force-pushed the renovate/typedoc-plugin-markdown-4.x branch from 7b8329e to 852021c Compare September 23, 2024 00:25
@renovate renovate bot force-pushed the renovate/typedoc-plugin-markdown-4.x branch from 852021c to 64968a3 Compare October 1, 2024 22:32
@renovate renovate bot force-pushed the renovate/typedoc-plugin-markdown-4.x branch 3 times, most recently from b4de196 to 374bb57 Compare October 16, 2024 09:27
@renovate renovate bot force-pushed the renovate/typedoc-plugin-markdown-4.x branch from 374bb57 to efb1379 Compare November 2, 2024 00:26
@renovate renovate bot force-pushed the renovate/typedoc-plugin-markdown-4.x branch from efb1379 to 2a22f91 Compare November 15, 2024 14:02
@renovate renovate bot force-pushed the renovate/typedoc-plugin-markdown-4.x branch from 2a22f91 to 9929fb9 Compare November 15, 2024 15:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
dependencies Pull requests that update a dependency file
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
0 participants