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

fix(deps): update dependency typedoc-plugin-markdown to v4.0.1 - autoclosed #1986

Closed
wants to merge 1 commit into from

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Mar 21, 2024

Mend Renovate

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
typedoc-plugin-markdown (source) 4.0.0-next.17 -> 4.0.1 age adoption passing confidence

Release Notes

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

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.

v4.0.0-next.60

Compare Source

Patch Changes
  • Added footer partial and footer.text mappings.
  • remove header readme labell

v4.0.0-next.59

Compare Source

Patch Changes
  • Removed deprecated options.
  • Tweaked link behaviour in page header.
  • Added symbols to external links.

v4.0.0-next.58

Compare Source

Patch Changes
  • Fixed navigation type error (#​595)

v4.0.0-next.57

Compare Source

Patch Changes
  • Fix broken links in packages index.
  • Added navigationModel option.

v4.0.0-next.56

Compare Source

Patch Changes
  • Expose 'Default value` column to properties table.
  • Added sanitizeComments option.
  • Navigation structure updates.

v4.0.0-next.55

Compare Source

Patch Changes
  • Added flattenOutputFiles option.
  • Lowercased Object keyword.

v4.0.0-next.54

Compare Source

v4.0.0-next.53

Compare Source

Patch Changes
  • Fixed omitted object literal default values.

v4.0.0-next.52

Compare Source

Patch Changes
  • Expose useMDXFileExt option.
  • Fix hooks being called in incorrect order.

v4.0.0-next.51

Compare Source

v4.0.0-next.50

Compare Source

Patch Changes
  • Fix "undefined" custom @group headings.

v4.0.0-next.49

Compare Source

Patch Changes
  • Fixed publicPath implemention.

v4.0.0-next.48

Compare Source

Patch Changes
  • Ignore seperate module index when entryModule is defined.

v4.0.0-next.47

Compare Source

Patch Changes
  • Fix params being incorrectly escaped in list format.
  • Removed generator in footer.
  • Fix typing of the defineTheme method.

v4.0.0-next.46

Compare Source

Patch Changes
  • Allow jsx style curly braces in comments.

v4.0.0-next.45: typedoc-plugin-markdown@4.0.0-next.44/45

Compare Source

Patch Changes
  • Expose textContentMappings to navigation
  • Expose theme hooks similar to default theme.
  • Expose TypedDoc media and include syntax.
  • Expose @experimental and @internal doc flags
  • Handle symbols with same name when generating urls
  • Expose version to breadcrumbs.home text mapping
  • Escape curly braces inside comment blocks.

v4.0.0-next.44

Compare Source

v4.0.0-next.43

Compare Source

Patch Changes
  • Updated documentation

v4.0.0-next.42

Compare Source

Patch Changes
  • Fixed navigation structure

v4.0.0-next.41

Compare Source

v4.0.0-next.40

Compare Source

v4.0.0-next.39

Compare Source

Patch Changes

v4.0.0-next.38

Compare Source

Patch Changes
  • Packages output file fixes

v4.0.0-next.37

Compare Source

Patch Changes
  • Enable outputFileStrategy in "packages" mode

v4.0.0-next.36

Compare Source

Patch Changes
  • Updated breadcrumbs UI

v4.0.0-next.35

Compare Source

Patch Changes
  • Fixed mergeReadme for packages entryPointStrategy

v4.0.0-next.34

Compare Source

Patch Changes
  • Expose mergeReadme option

v4.0.0-next.33

Compare Source

Patch Changes
  • Exposed publicPath option

v4.0.0-next.32

Compare Source

Patch Changes
  • Generate packages.md even if groups used

v4.0.0-next.31

Compare Source

Patch Changes
  • Strikethough members marked as deprecated
  • Expose returned declarations for reference types

v4.0.0-next.30

Compare Source

Patch Changes
  • Update header UI

v4.0.0-next.29

Compare Source

Patch Changes
  • Fixed paraterTable style on declarations
  • UI updates

v4.0.0-next.28

Compare Source

Patch Changes
  • Expose --entryModule option
  • UI updates to header and breadcrumbs
  • Prevent MDX parsing symbols as markdown links

v4.0.0-next.27

Compare Source

Patch Changes
  • Preserve slash in module filenames

v4.0.0-next.26

Compare Source

Patch Changes
  • Support angle brackets, slashes and leading numbers in module names

v4.0.0-next.25

Compare Source

Patch Changes
  • Fixed missing return types
  • Added --mergeReadme option
  • Tweaked and added specs for reference types
  • Updated default --indexPageTitle to {projectName}
  • Renamed --titleTemplate -> --memberPageTitle

v4.0.0-next.24

Compare Source

Patch Changes
  • Correctly resolve packge readme urls from member pages (#​483)
  • Prevent trigger of reversed link syntax rule on index access types (#​484)

v4.0.0-next.23

Compare Source

Patch Changes
  • Updated toc implementation
  • Fixed indexPageTitle optio

v4.0.0-next.22

Compare Source

Patch Changes
  • Updated index filenames and Removed indexFileName option

v4.0.0-next.21

Compare Source

Patch Changes
  • Several ui improvements
  • Simplified option names
  • Improved documentation
  • Fixed and refactored tests

v4.0.0-next.20

Compare Source

Patch Changes
  • UI improvements
  • Enable anchor to items inside table

v4.0.0-next.19

Compare Source

Patch Changes
  • TypeDoc 0.25.0 compatibility fixes

v4.0.0-next.18

Compare Source

Patch Changes
  • Split out comment summary and tags for signatures
  • Added titleTemplate option to replace hideKindPrefix option
  • Fixed incorrect heading title for monorepo packages
  • Disable in-built Prettier formatting

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 has been generated by Mend Renovate. View repository job log here.

@renovate renovate bot requested a review from a team as a code owner March 21, 2024 16:58
Copy link
Contributor Author

renovate bot commented Mar 21, 2024

⚠ 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: pnpm-lock.yaml
Scope: all 5 workspace projects
Progress: resolved 0, reused 0, downloaded 1, added 0
Progress: resolved 17, reused 0, downloaded 16, added 0
Progress: resolved 25, reused 0, downloaded 24, added 0
Progress: resolved 45, reused 0, downloaded 33, added 0
Progress: resolved 94, reused 0, downloaded 79, added 0
Progress: resolved 163, reused 0, downloaded 148, added 0
Progress: resolved 180, reused 0, downloaded 162, added 0
Progress: resolved 229, reused 0, downloaded 202, added 0
Progress: resolved 367, reused 0, downloaded 339, added 0
Progress: resolved 511, reused 0, downloaded 443, added 0
Progress: resolved 555, reused 0, downloaded 477, added 0
Progress: resolved 600, reused 0, downloaded 523, added 0
 ERR_PNPM_PATCH_NOT_APPLIED  The following patches were not applied: typedoc-plugin-markdown@4.0.0-next.17

Either remove them from "patchedDependencies" or update them to match packages in your dependencies.

Copy link

netlify bot commented Mar 21, 2024

Deploy Preview for tauri-v2 failed.

Name Link
🔨 Latest commit 08a11e0
🔍 Latest deploy log https://app.netlify.com/sites/tauri-v2/deploys/663e1a6c14e4d30008e213f6

@renovate renovate bot force-pushed the renovate/typedoc-plugin-markdown-4.x branch from 028d8b7 to 2e4d598 Compare April 5, 2024 18:40
@renovate renovate bot changed the title fix(deps): update dependency typedoc-plugin-markdown to v4.0.0-next.54 fix(deps): update dependency typedoc-plugin-markdown to v4.0.0-next.55 Apr 5, 2024
@renovate renovate bot force-pushed the renovate/typedoc-plugin-markdown-4.x branch from 2e4d598 to 1fdd57f Compare April 19, 2024 22:39
@renovate renovate bot changed the title fix(deps): update dependency typedoc-plugin-markdown to v4.0.0-next.55 fix(deps): update dependency typedoc-plugin-markdown to v4.0.0-next.56 Apr 19, 2024
@FabianLars FabianLars marked this pull request as draft April 20, 2024 16:57
@renovate renovate bot force-pushed the renovate/typedoc-plugin-markdown-4.x branch from 1fdd57f to 3078d1f Compare April 21, 2024 01:37
@renovate renovate bot changed the title fix(deps): update dependency typedoc-plugin-markdown to v4.0.0-next.56 fix(deps): update dependency typedoc-plugin-markdown to v4.0.0-next.57 Apr 21, 2024
@renovate renovate bot force-pushed the renovate/typedoc-plugin-markdown-4.x branch from 3078d1f to 8a4ce61 Compare April 21, 2024 23:22
@renovate renovate bot changed the title fix(deps): update dependency typedoc-plugin-markdown to v4.0.0-next.57 fix(deps): update dependency typedoc-plugin-markdown to v4.0.0-next.58 Apr 21, 2024
@renovate renovate bot force-pushed the renovate/typedoc-plugin-markdown-4.x branch from 8a4ce61 to 134d034 Compare May 3, 2024 19:27
@renovate renovate bot changed the title fix(deps): update dependency typedoc-plugin-markdown to v4.0.0-next.58 fix(deps): update dependency typedoc-plugin-markdown to v4.0.0 May 3, 2024
@renovate renovate bot force-pushed the renovate/typedoc-plugin-markdown-4.x branch 2 times, most recently from d394b10 to 1674be2 Compare May 7, 2024 04:54
@renovate renovate bot changed the title fix(deps): update dependency typedoc-plugin-markdown to v4.0.0 fix(deps): update dependency typedoc-plugin-markdown to v4.0.1 May 7, 2024
@renovate renovate bot force-pushed the renovate/typedoc-plugin-markdown-4.x branch from 1674be2 to 08a11e0 Compare May 10, 2024 13:00
Copy link
Contributor Author

renovate bot commented May 10, 2024

⚠️ 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: pnpm-lock.yaml
Scope: all 5 workspace projects
Progress: resolved 1, reused 0, downloaded 0, added 0
Progress: resolved 27, reused 0, downloaded 0, added 0
Progress: resolved 69, reused 0, downloaded 0, added 0
Progress: resolved 162, reused 0, downloaded 0, added 0
Progress: resolved 232, reused 0, downloaded 0, added 0
Progress: resolved 347, reused 0, downloaded 0, added 0
Progress: resolved 475, reused 0, downloaded 0, added 0
Progress: resolved 623, reused 0, downloaded 0, added 0
 ERR_PNPM_PATCH_NOT_APPLIED  The following patches were not applied: typedoc-plugin-markdown@4.0.0-next.17

Either remove them from "patchedDependencies" or update them to match packages in your dependencies.

Copy link

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

Package New capabilities Transitives Size Publisher
npm/typedoc-plugin-markdown@4.0.1 filesystem 0 305 kB tgreyuk

🚮 Removed packages: npm/typedoc-plugin-markdown@4.0.0-next.17

View full report↗︎

@renovate renovate bot changed the title fix(deps): update dependency typedoc-plugin-markdown to v4.0.1 fix(deps): update dependency typedoc-plugin-markdown to v4.0.1 - autoclosed May 14, 2024
@renovate renovate bot closed this May 14, 2024
@renovate renovate bot deleted the renovate/typedoc-plugin-markdown-4.x branch May 14, 2024 22:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

None yet

0 participants