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

deps: bump typedoc and typedoc-plugin-markdown #191

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

Conversation

dependabot[bot]
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github Oct 4, 2024

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

Release notes

Sourced from typedoc's releases.

v0.26.8

Features

  • Updated Chinese translations, #2706.
  • Exported constants no longer render the type and default value if they are the same, #2717.
  • The HTML output now wraps tag blocks with <div> tags and includes the tag name in a class name, #2723.

Bug Fixes

  • Correctly handle external link resolver link text when referencing an external symbol, #2700.
  • Big integer literals are now supported as default values, #2721.
  • Corrected handling of @link tags present in comments at the start of source files.
  • The index will now display when a module only contains documents, #2722.
  • ReflectionSymbolId.pos no longer references the position before any doc comments for a symbol. This could cause typedoc-plugin-dt-links to produce links which didn't go to the expected location in a file.

Thanks!

v0.26.7

Features

  • Support TypeScript 5.6, #2699.
  • Added customJs option to include a script tag in generated HTML output, #2650.
  • Added markdownLinkExternal option to treat http[s]:// links in markdown documents and comments as external to be opened in a new tab, #2679.
  • Added navigation.excludeReferences option to prevent re-exports from appearing in the left hand navigation, #2685.
  • Added support for the @abstract tag, #2692.

Bug Fixes

  • Fixed an issue where links in packages mode would be resolved incorrectly, #2680.
  • @link tags to symbols which are not included in the documentation will produce invalid link warnings again, #2681.
  • Fixed handling of @param tags on comments attached to function callback parameters, #2683.
  • The alphabetical and alphabetical-ignoring-documents sort options now use localeCompare to sort, #2684.
  • Fixed incorrect placement of parameter default values in some signatures with a this parameter, #2698.

Thanks!

v0.26.6

Features

... (truncated)

Changelog

Sourced from typedoc's changelog.

v0.26.8 (2024-10-04)

Features

  • Updated Chinese translations, #2706.
  • Exported constants no longer render the type and default value if they are the same, #2717.
  • The HTML output now wraps tag blocks with <div> tags and includes the tag name in a class name, #2723.

Bug Fixes

  • Correctly handle external link resolver link text when referencing an external symbol, #2700.
  • Big integer literals are now supported as default values, #2721.
  • Corrected handling of @link tags present in comments at the start of source files.
  • The index will now display when a module only contains documents, #2722.
  • ReflectionSymbolId.pos no longer references the position before any doc comments for a symbol. This could cause typedoc-plugin-dt-links to produce links which didn't go to the expected location in a file.

Thanks!

v0.26.7 (2024-09-09)

Features

  • Support TypeScript 5.6, #2699.
  • Added customJs option to include a script tag in generated HTML output, #2650.
  • Added markdownLinkExternal option to treat http[s]:// links in markdown documents and comments as external to be opened in a new tab, #2679.
  • Added navigation.excludeReferences option to prevent re-exports from appearing in the left hand navigation, #2685.
  • Added support for the @abstract tag, #2692.

Bug Fixes

  • Fixed an issue where links in packages mode would be resolved incorrectly, #2680.
  • @link tags to symbols which are not included in the documentation will produce invalid link warnings again, #2681.
  • Fixed handling of @param tags on comments attached to function callback parameters, #2683.
  • The alphabetical and alphabetical-ignoring-documents sort options now use localeCompare to sort, #2684.
  • Fixed incorrect placement of parameter default values in some signatures with a this parameter, #2698.

Thanks!

v0.26.6 (2024-08-18)

Features

... (truncated)

Commits
  • 59ec968 Update changelog for release
  • a65766d Bump version to 0.26.8
  • 77cf917 Fix missing index with only document children
  • d349280 ReflectionSymbolId.pos uses getStart for position
  • 40d1cec Merge pull request #2724 from lriggle-strib/master
  • 2445045 Add div wrapper around tags in comment partial.
  • 81fec38 Update changelog for fixing #2717
  • bdd610c Add handling for bigint literals in default values
  • 1dbfe3a Merge pull request #2721 from Corso02/master
  • b9f56e0 simplified checking if type should be rendered
  • Additional commits viewable in compare view

Updates typedoc-plugin-markdown from 4.0.3 to 4.2.9

Release notes

Sourced from typedoc-plugin-markdown's releases.

[email protected]

Patch Changes

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

[email protected]

Patch Changes

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

[email protected]

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

[email protected]

Patch Changes

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

[email protected]

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)

[email protected]

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

[email protected]

Patch Changes

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

[email protected]

Patch Changes

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

[email protected]

... (truncated)

Changelog

Sourced from typedoc-plugin-markdown's changelog.

4.2.9 (2024-10-01)

Patch Changes

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

4.2.8 (2024-09-22)

Patch Changes

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

4.2.7 (2024-09-05)

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

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)

... (truncated)

Commits
  • 1cd85ca Version Packages
  • 563875e fix(core): add parentheses on function names in type declaration table views ...
  • 300db20 fix(core): expose "@​return" block tags on declarations (#694)
  • 974a60d chore(docs): updated docs
  • e60b02e Version Packages
  • a7e4775 fix(core): fix missing slash when public path is prefixed with http (#688)
  • 21c6811 chore(docs): updated changelog date
  • d1bf2a5 Version Packages
  • 37f3b34 chore(docs): updated navigation docs
  • fa60205 fix(core): trim link label
  • 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.8
- [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.8)

Updates `typedoc-plugin-markdown` from 4.0.3 to 4.2.9
- [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/[email protected]/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] <[email protected]>
@dependabot dependabot bot added the dependencies Pull requests that update a dependency file label Oct 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Pull requests that update a dependency file
Projects
None yet
Development

Successfully merging this pull request may close these issues.

0 participants