Skip to content
This repository was archived by the owner on Apr 21, 2025. It is now read-only.

Conversation

@dependabot
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github Jan 1, 2025

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

Release notes

Sourced from typedoc's releases.

v0.27.6

Features

  • Added ignoredHighlightLanguages option to specify languages which will be allowed in code blocks but not highlighted, #2819.

Bug Fixes

  • @include and @includeCode now work in the readme file, #2814.
  • TypeDoc will now avoid making references to references, #2811.
  • Fixed output specific option specification, #2818.
  • Improved type reference conversion to avoid including defaulted type arguments, #2820.
  • Fixed parsing of declaration references which include a module and a local reference, #2810.
  • Improved link resolution logic to prioritize type alias properties with the same symbol over type literal properties within function parameters.

v0.27.5

Bug Fixes

  • Possibly Breaking: TypeDoc will no longer render anchors within the page for deeply nested properties. This only affects links to properties of properties of types, which did not have a clickable link exposed so are unlikely to have been linked to. Furthermore, these links were not always created by TypeDoc, only being created if all parent properties contained comments, #2808.
  • TypeDoc will now warn if a property which does not have a URL within the rendered document and the parent property/page will be linked to instead, #2808. These warnings can be disabled with the validation.rewrittenLink option.
  • Fix restoration of groups/categories including documents, #2801.
  • Fixed missed relative paths within markdown link references in documents.
  • Improved handling of incomplete inline code blocks within markdown.
  • Direct https:// links under the hostedBaseUrl option's URL will no longer be treated as external, #2809.

Thanks!

v0.27.4

Features

  • API: Introduced new Converter.EVENT_CREATE_PROJECT event which fires when a project is created by the converter, #2800.

Bug Fixes

  • Switch from gzip to deflate for compressing assets to make output consistent across different operating systems, #2796.

... (truncated)

Changelog

Sourced from typedoc's changelog.

v0.27.6 (2024-12-26)

Features

  • Added ignoredHighlightLanguages option to specify languages which will be allowed in code blocks but not highlighted, #2819.

Bug Fixes

  • @include and @includeCode now work in the readme file, #2814.
  • TypeDoc will now avoid making references to references, #2811.
  • Fixed output specific option specification, #2818.
  • Improved type reference conversion to avoid including defaulted type arguments, #2820.
  • Fixed parsing of declaration references which include a module and a local reference, #2810.
  • Improved link resolution logic to prioritize type alias properties with the same symbol over type literal properties within function parameters.

v0.27.5 (2024-12-14)

Bug Fixes

  • Possibly Breaking: TypeDoc will no longer render anchors within the page for deeply nested properties. This only affects links to properties of properties of types, which did not have a clickable link exposed so are unlikely to have been linked to. Furthermore, these links were not always created by TypeDoc, only being created if all parent properties contained comments, #2808.
  • TypeDoc will now warn if a property which does not have a URL within the rendered document and the parent property/page will be linked to instead, #2808. These warnings can be disabled with the validation.rewrittenLink option.
  • Fix restoration of groups/categories including documents, #2801.
  • Fixed missed relative paths within markdown link references in documents.
  • Improved handling of incomplete inline code blocks within markdown.
  • Direct https:// links under the hostedBaseUrl option's URL will no longer be treated as external, #2809.

Thanks!

v0.27.4 (2024-12-09)

Features

  • API: Introduced new Converter.EVENT_CREATE_PROJECT event which fires when a project is created by the converter, #2800.

Bug Fixes

  • Switch from gzip to deflate for compressing assets to make output consistent across different operating systems, #2796.

... (truncated)

Commits
  • 9a1a719 Update changelog for release
  • 44bffe8 Release v0.27.6
  • d626468 Fix @link with declaration reference using !~
  • 9e667d0 Add ignoredHighlightLanguages option
  • 9b62f09 Fix output specific option specification
  • 53fa22e Avoid including defaulted type arguments
  • b9177b4 Update contributing docs
  • 23008f6 Improve link resolution prioritization
  • 2c10f67 Avoid references to references
  • 016e6a1 Lock npm to 10 for CI
  • Additional commits viewable in compare view

Updates typedoc-plugin-markdown from 4.2.10 to 4.4.0

Release notes

Sourced from typedoc-plugin-markdown's releases.

typedoc-plugin-markdown@4.4.0

Minor Changes

  • Expose "isDeprecated" flag to navigation model (#747).
  • Moved source link inline and exposed to all parent symbols (#746).
  • Remove extraneous "Index" headings.
  • Always assign HTML anchor ids to linkable symbols within table rows.

Patch Changes

  • Always display inline object for tuple types (#745).
  • Strikeout deprecated items in reflection indexes.
  • Fix inline formatting of types when when "useCodeBlocks" is used (#742).
  • Expose group descriptions to module indexes.
  • Expose global documents with "packages" entryPointStrategy.

typedoc-plugin-markdown@4.3.3

Patch Changes

  • Correctly handle anchor resolutions with table formats.
  • Fix invalid typescript syntax for type aliases inside declaration code blocks when "useCodeBlocks" is true (#741).

typedoc-plugin-markdown@4.3.2

Patch Changes

  • Enable {@link} resolution on type alias properties (#732).
  • Remove superfluous name attribute when "useHtmlAnchors" is true..
  • Escape characters inside @link tags.
  • Fixed spacing around inline object declarations.
  • Always expose type arguments of reference types as per default theme (#733).

typedoc-plugin-markdown@4.3.1

Patch Changes

  • Expose type declarations to array types.
  • Correctly wrap array of unions in parenthesis (#719).
  • Omit inline parameter declarations when not useful (#720).

typedoc-plugin-markdown@4.3.0

Minor Changes

  • Implemented typedoc 0.27 compatibility support.
  • Exposed "typeDeclarationVisibility" option to provide a "compact" output structure (#703).
  • Exposed "pageTitleTemplates" option that accepts a string with placeholder or function arguments to control page titles (#715).
  • Exposed formatting with prettier options "formatWithPrettier" and "prettierConfigFile" that enables additional formatting of output if Prettier is installed on a project.

Patch Changes

  • Improved structure of curried and overloaded signatures (#714) (#718)
  • The "hideGroupHeadings" option respects group order (#716)

... (truncated)

Changelog

Sourced from typedoc-plugin-markdown's changelog.

4.4.0 (2024-12-30)

This release introduces structural enhancements to the user interface and bug fixes to enhance overall functionality.

Structural Changes

  • Source file links are now placed inline rather than under separate "Defined in" headings. This change aligns with the default HTML theme, generates more compact output, and improves the readability of automatically generated Table of Contents (TOCs).
  • Extraneous "Index" headings on module landing pages have been removed, bringing the structure in line with the default HTML theme and reducing unnecessary clutter.
  • Anchor IDs are now applied to linkable symbols within table rows by default. Previously, the useHTMLAnchors option was required, but since there is no alternative way to link to these items, this behaviour is now the default.

Minor Changes

  • Expose "isDeprecated" flag to navigation model (#747).
  • Moved source link inline and exposed to all parent symbols (#746).
  • Remove extraneous "Index" headings.
  • Always assign HTML anchor ids to linkable symbols within table rows.

Patch Changes

  • Always display inline object for tuple types (#745).
  • Strikeout deprecated items in reflection indexes.
  • Fix inline formatting of types when when "useCodeBlocks" is used (#742).
  • Expose group descriptions to module indexes.
  • Expose global documents with "packages" entryPointStrategy.

4.3.3 (2024-12-18)

Patch Changes

  • Correctly handle anchor resolutions with table formats.
  • Fix invalid typescript syntax for type aliases inside declaration code blocks when "useCodeBlocks" is true (#741).

4.3.2 (2024-12-08)

Patch Changes

  • Enable {@link} resolution on type alias properties (#732).
  • Remove superfluous name attribute when "useHtmlAnchors" is true..
  • Escape characters inside @link tags.
  • Fixed spacing around inline object declarations.
  • Always expose type arguments of reference types as per default theme (#733).

4.3.1 (2024-12-01)

Patch Changes

  • Expose type declarations to array types.
  • Correctly wrap array of unions in parenthesis (#719).
  • Omit inline parameter declarations when not useful (#720).

... (truncated)

Commits
  • 1b0d04b Version Packages
  • 28e23bc chore(all): updated dev docs
  • 591939c fix(core): fix index generation issues
  • 75cf255 chore(docs): moved api docs
  • 640b9ca feat(core): always assign header ids to linkable symbols within table rows
  • 5fd0f09 chore(core): updated packages
  • ad41189 fix(core): isDeprecated logic updates
  • 87d044e fix(core): expose group descriptions to module indexes
  • e798507 fix(core): moved source link inline and exposed to all parent symbols
  • 09f6e97 fix(core): always display inline object for tuple type
  • 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.26.11 to 0.27.6
- [Release notes](https://github.com/TypeStrong/TypeDoc/releases)
- [Changelog](https://github.com/TypeStrong/typedoc/blob/master/CHANGELOG.md)
- [Commits](TypeStrong/typedoc@v0.26.11...v0.27.6)

Updates `typedoc-plugin-markdown` from 4.2.10 to 4.4.0
- [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.4.0/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>
@dependabot @github
Copy link
Contributor Author

dependabot bot commented on behalf of github Jan 1, 2025

The following labels could not be found: type: chore \U0001F9F9.

@github-actions github-actions bot enabled auto-merge (squash) January 1, 2025 01:16
@github-actions github-actions bot merged commit 9df92c3 into main Jan 1, 2025
3 checks passed
@github-actions github-actions bot deleted the dependabot-npm_and_yarn-main-multi-e00da71651 branch January 1, 2025 01:17
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants