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

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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

dependabot[bot]
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github Jul 12, 2024

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

Release notes

Sourced from typedoc's releases.

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!

v0.26.3

Features

  • "On This Page" navigation now includes the page groups in collapsible sections, #2616.

Bug Fixes

  • mailto: links are no longer incorrectly recognized as relative paths, #2613.
  • Added @since to the default list of recognized tags, #2614.
  • Relative paths to directories will no longer cause the directory to be copied into the media directory, #2617.

v0.26.2

Features

  • Added a --suppressCommentWarningsInDeclarationFiles option to disable warnings from parsing comments in declaration files, #2611.
  • Improved comment discovery to more closely match TypeScript's discovery when getting comments for members of interfaces/classes, #2084, #2545.

Bug Fixes

  • The text non-highlighted language no longer causes warnings when rendering, #2610.
  • If a comment on a method is inherited from a parent class, and the child class does not use an @param tag from the parent, TypeDoc will no longer warn about the @param tag.

v0.26.1

Features

... (truncated)

Changelog

Sourced from typedoc's changelog.

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!

v0.26.3 (2024-06-28)

Features

  • "On This Page" navigation now includes the page groups in collapsible sections, #2616.

Bug Fixes

  • mailto: links are no longer incorrectly recognized as relative paths, #2613.
  • Added @since to the default list of recognized tags, #2614.
  • Relative paths to directories will no longer cause the directory to be copied into the media directory, #2617.

v0.26.2 (2024-06-24)

Features

  • Added a --suppressCommentWarningsInDeclarationFiles option to disable warnings from parsing comments in declaration files, #2611.
  • Improved comment discovery to more closely match TypeScript's discovery when getting comments for members of interfaces/classes, #2084, #2545.

Bug Fixes

  • The text non-highlighted language no longer causes warnings when rendering, #2610.
  • If a comment on a method is inherited from a parent class, and the child class does not use an @param tag from the parent, TypeDoc will no longer warn about the @param tag.

v0.26.1 (2024-06-22)

Features

... (truncated)

Commits
  • 9426642 Update changelog for release
  • 03bb21f Release 0.26.4
  • e2051dc Add a test for CRLF line endings
  • 21cf5ae chore: lint
  • ef0f26e fix: frontmatter parsing in windows (CLRF)
  • f0f0106 Add trailing newline to generated doc files
  • 32fff2b Fix @hidden on function implementations
  • 1f58143 Correctly handle @link in documents
  • d04ea32 Fix media links if referenced multiple times
  • dae2527 Fix page navigation sidebar with re-exports
  • Additional commits viewable in compare view

Updates typedoc-plugin-markdown from 4.0.3 to 4.2.1

Release notes

Sourced from typedoc-plugin-markdown's releases.

[email protected]

Patch Changes

  • Fix missing index descriptions for signatures (#618)

[email protected]

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

[email protected]

Patch Changes

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

[email protected]

Patch Changes

  • normalize window paths when "publicPath" is set (#639)

[email protected]

Minor Changes

  • 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)
Changelog

Sourced from typedoc-plugin-markdown's changelog.

4.2.1

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

4.1.2 (2024-07-05)

Patch Changes

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

4.1.1 (2024-06-30)

Patch Changes

  • Normalize window paths when "publicPath" is set (#639)

4.1.0 (2024-06-22)

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)
Commits
  • ac40179 Version Packages
  • 3e685ab fix(core): fix missing index descriptions for signatures (#618)
  • 579705a chore(docs): updated docs
  • 1033b39 Version Packages
  • 063ca57 Merge branch 'dev'
  • d8b983d feat(core): write .nojekyll file if TypeDocs "githubPages" option is true ...
  • a1a8446 feat(core): exposed "modulesFileName" option (#647)
  • 337e060 chore(docs): updated changelog date
  • b710dc9 fix(core): display all available markdown content for index html tables
  • 0a99220 chore(docs): updated changelog date
  • Additional commits viewable in compare view

You can trigger a rebase of this PR 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)

Note
Automatic rebases have been disabled on this pull request as it has been open for over 30 days.

@dependabot dependabot bot added automerge dependencies Pull requests that update a dependency file labels Jul 12, 2024
@dependabot dependabot bot force-pushed the dependabot/npm_and_yarn/multi-5045d61f8d branch from c8b4b91 to dbfb54f Compare July 12, 2024 06:34
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.4
- [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.4)

Updates `typedoc-plugin-markdown` from 4.0.3 to 4.2.1
- [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 force-pushed the dependabot/npm_and_yarn/multi-5045d61f8d branch from dbfb54f to 7f7ce9c Compare July 12, 2024 06:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
automerge dependencies Pull requests that update a dependency file
Projects
None yet
Development

Successfully merging this pull request may close these issues.

0 participants