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

build(deps): bump typedoc-plugin-markdown from 3.17.1 to 4.0.0 in /website #3794

Conversation

dependabot[bot]
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github May 6, 2024

Bumps typedoc-plugin-markdown from 3.17.1 to 4.0.0.

Release notes

Sourced from typedoc-plugin-markdown's releases.

[email protected]

Changelog

4.0.0 (2024-05-03)

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

... (truncated)

Changelog

Sourced from typedoc-plugin-markdown's changelog.

4.0.0 (2024-05-03)

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)

... (truncated)

Commits
  • a1250dc fix(core): emphasised header items
  • ced95cd chore(global): version packages for release
  • aa5fd6a chore(global): updated docs for release
  • 7cab561 Version Packages (next)
  • 79ff27e chore(global): docs updates
  • 2e5959c feat(core): added footer partial and footer.text mappings
  • 61d13ec fix(core): remove header readme label
  • 8a38ac9 Version Packages (next)
  • ce8756a chore: Updated docs
  • 83413ba chore: updated docs
  • Additional commits viewable in compare view

Dependabot compatibility score

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)

@dependabot dependabot bot added dependencies Pull requests that update a dependency file javascript Pull requests that update Javascript code labels May 6, 2024
@dependabot dependabot bot force-pushed the dependabot/npm_and_yarn/website/typedoc-plugin-markdown-4.0.0 branch from 8e01fbb to e354595 Compare May 6, 2024 04:01
Copy link
Contributor Author

dependabot bot commented on behalf of github May 7, 2024

Superseded by #3801.

@dependabot dependabot bot closed this May 7, 2024
@dependabot dependabot bot deleted the dependabot/npm_and_yarn/website/typedoc-plugin-markdown-4.0.0 branch May 7, 2024 03:10
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 javascript Pull requests that update Javascript code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

0 participants