Skip to content
This repository was archived by the owner on Mar 23, 2026. It is now read-only.

chore(deps-dev): bump typedoc and typedoc-plugin-markdown#638

Open
dependabot[bot] wants to merge 1 commit intomainfrom
dependabot-npm_and_yarn-main-multi-0af3eec4f9
Open

chore(deps-dev): bump typedoc and typedoc-plugin-markdown#638
dependabot[bot] wants to merge 1 commit intomainfrom
dependabot-npm_and_yarn-main-multi-0af3eec4f9

Conversation

@dependabot
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github Sep 1, 2024

Bumps typedoc and typedoc-plugin-markdown. These dependencies needed to be updated together.
Updates typedoc from 0.25.13 to 0.26.6

Release notes

Sourced from typedoc's releases.

v0.26.6

Features

  • Use of the @extends block tag no longer produces warnings, #2659. This tag should only be used in JavaScript projects to specify the type parameters used when extending a parent class. It will not be rendered.
  • Added new navigation.compactFolders option to prevent TypeDoc from compacting folders, similar to the VSCode option. #2667.

Bug Fixes

  • The suppressCommentWarningsInDeclarationFiles option now correctly ignores warnings in .d.cts and .d.mts files, #2647.
  • Restored re-exports in the page navigation menu, #2671.
  • JSON serialized projects will no longer contain reflection IDs for other projects created in the same run. Gerrit0/typedoc-plugin-zod0.
  • In packages mode the reflection ID counter will no longer be reset when converting projects. This previously could result in links to files not working as expected.

v0.26.5

Features

  • TypeDoc now exposes array option defaults under OptionDefaults, #2640.

Bug Fixes

  • Constructor parameters which share a name with a property on a parent class will no longer inherit the comment on the parent class, #2636.
  • Packages mode will now attempt to use the comment declared in the comment class for inherited members, #2622.
  • TypeDoc no longer crashes when @document includes an empty file, #2638.
  • API: Event listeners added later with the same priority will be called later, #2643.

Thanks!

v0.26.4

Bug Fixes

  • The page navigation sidebar no longer incorrectly includes re-exports if the same member is exported with multiple names #2625.
  • Page navigation now ensures the current page is visible when the page is first loaded, #2626.
  • If a relative linked image is referenced multiple times, TypeDoc will no longer sometimes produce invalid links to the image #2627.
  • @link tags will now be validated in referenced markdown documents, #2629.
  • @link tags are now resolved in project documents, #2629.
  • HTML/JSON output generated by TypeDoc now contains a trailing newline, #2632.
  • TypeDoc now correctly handles markdown documents with CRLF line endings, #2628.
  • @hidden is now properly applied when placed in a function implementation comment, #2634.
  • Comments on re-exports are now rendered.

Thanks!

... (truncated)

Changelog

Sourced from typedoc's changelog.

v0.26.6 (2024-08-18)

Features

  • Use of the @extends block tag no longer produces warnings, #2659. This tag should only be used in JavaScript projects to specify the type parameters used when extending a parent class. It will not be rendered.
  • Added new navigation.compactFolders option to prevent TypeDoc from compacting folders, similar to the VSCode option. #2667.

Bug Fixes

  • The suppressCommentWarningsInDeclarationFiles option now correctly ignores warnings in .d.cts and .d.mts files, #2647.
  • Restored re-exports in the page navigation menu, #2671.
  • JSON serialized projects will no longer contain reflection IDs for other projects created in the same run. Gerrit0/typedoc-plugin-zod0.
  • In packages mode the reflection ID counter will no longer be reset when converting projects. This previously could result in links to files not working as expected.

v0.26.5 (2024-07-21)

Features

  • TypeDoc now exposes array option defaults under OptionDefaults, #2640.

Bug Fixes

  • Constructor parameters which share a name with a property on a parent class will no longer inherit the comment on the parent class, #2636.
  • Packages mode will now attempt to use the comment declared in the comment class for inherited members, #2622.
  • TypeDoc no longer crashes when @document includes an empty file, #2638.
  • API: Event listeners added later with the same priority will be called later, #2643.

Thanks!

v0.26.4 (2024-07-10)

Bug Fixes

  • The page navigation sidebar no longer incorrectly includes re-exports if the same member is exported with multiple names #2625.
  • Page navigation now ensures the current page is visible when the page is first loaded, #2626.
  • If a relative linked image is referenced multiple times, TypeDoc will no longer sometimes produce invalid links to the image #2627.
  • @link tags will now be validated in referenced markdown documents, #2629.
  • @link tags are now resolved in project documents, #2629.
  • HTML/JSON output generated by TypeDoc now contains a trailing newline, #2632.
  • TypeDoc now correctly handles markdown documents with CRLF line endings, #2628.
  • @hidden is now properly applied when placed in a function implementation comment, #2634.
  • Comments on re-exports are now rendered.

Thanks!

... (truncated)

Commits
  • f0f3d96 Update changelog for release
  • 182adbb Fix lint
  • aa2b4a9 Conditionally serialize media->reflection entries
  • 73e1dd6 Add navigation.compactFolders option
  • 3673a4d Include re-exports in page navigation menu
  • 3e13dc1 Merge pull request #2664 from nick-ls/master
  • f0de38c Merge pull request #2665 from waynemwashuma/master
  • dfb19e6 Add support for "none" group
  • ec1f863 Add support for @augments
  • ce7b3b4 Add support for "none" category
  • Additional commits viewable in compare view

Updates typedoc-plugin-markdown from 4.0.3 to 4.2.6

Release notes

Sourced from typedoc-plugin-markdown's releases.

typedoc-plugin-markdown@4.2.6

Patch Changes

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

typedoc-plugin-markdown@4.2.5

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)

typedoc-plugin-markdown@4.2.4

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

typedoc-plugin-markdown@4.2.3

Patch Changes

  • Fix missing return comments for const functions (#656)

typedoc-plugin-markdown@4.2.2

Patch Changes

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

typedoc-plugin-markdown@4.2.1

Patch Changes

  • Fix missing index descriptions for signatures (#618)

typedoc-plugin-markdown@4.2.0

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

typedoc-plugin-markdown@4.1.2

Patch Changes

  • Support TypeDoc 0.26 relative links implementation (#645).

... (truncated)

Changelog

Sourced from typedoc-plugin-markdown's changelog.

4.2.6 (2024-08-25)

Patch Changes

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

4.2.5 (2024-08-15)

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)

4.2.4 (2024-08-13)

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

4.2.3 (2024-07-24)

Patch Changes

  • Fix missing return comments for const functions (#656)

4.2.2 (2024-07-22)

Patch Changes

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

4.2.1 (2024-07-11)

Patch Changes

  • Fix missing index descriptions for signatures (#618)

4.2.0 (2024-07-10)

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

... (truncated)

Commits
  • 4d21c0b Version Packages
  • 310edc6 fix(core): expose missing entrypoints to navigation (#663)
  • e9ceaa3 fix(core): fix missing function descriptions in indexes
  • ef784f6 docs(all): updated changelog date
  • 63ee216 Version Packages
  • 6ba0a1c chore(docs): updated comments
  • 5be8459 fix(core): expose missing descriptions with accessor keyword (#664)
  • 7afe341 fix(core): expose comment for arrow functions in type declarations (#670)
  • 099ef16 fix(core): added thead and tbody elements to "htmlTable" (#671)
  • f6535be chore(docs): updated changelog date
  • Additional commits viewable in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.


Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

  • @dependabot rebase will rebase this PR
  • @dependabot recreate will recreate this PR, overwriting any edits that have been made to it
  • @dependabot merge will merge this PR after your CI passes on it
  • @dependabot squash and merge will squash and merge this PR after your CI passes on it
  • @dependabot cancel merge will cancel a previously requested merge and block automerging
  • @dependabot reopen will reopen this PR if it is closed
  • @dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
  • @dependabot show <dependency name> ignore conditions will show all of the ignore conditions of the specified dependency
  • @dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

Bumps [typedoc](https://github.com/TypeStrong/TypeDoc) and [typedoc-plugin-markdown](https://github.com/typedoc2md/typedoc-plugin-markdown/tree/HEAD/packages/typedoc-plugin-markdown). These dependencies needed to be updated together.

Updates `typedoc` from 0.25.13 to 0.26.6
- [Release notes](https://github.com/TypeStrong/TypeDoc/releases)
- [Changelog](https://github.com/TypeStrong/typedoc/blob/master/CHANGELOG.md)
- [Commits](TypeStrong/typedoc@v0.25.13...v0.26.6)

Updates `typedoc-plugin-markdown` from 4.0.3 to 4.2.6
- [Release notes](https://github.com/typedoc2md/typedoc-plugin-markdown/releases)
- [Changelog](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/CHANGELOG.md)
- [Commits](https://github.com/typedoc2md/typedoc-plugin-markdown/commits/typedoc-plugin-markdown@4.2.6/packages/typedoc-plugin-markdown)

---
updated-dependencies:
- dependency-name: typedoc
  dependency-type: direct:development
  update-type: version-update:semver-minor
- dependency-name: typedoc-plugin-markdown
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants