renovate[bot]
commented
2 months ago Renovate Ignore Notification
Because you closed this PR without merging, Renovate will ignore this update. You will not get PRs for any future 4.x releases. But if you manually upgrade to 4.x then Renovate will re-enable minor and patch updates automatically.
If you accidentally closed this PR, or if you changed your mind: rename this PR to get a fresh replacement PR.
This PR contains the following updates:
^3.15.3->^4.0.0Release Notes
typedoc2md/typedoc-plugin-markdown (typedoc-plugin-markdown)
### [`v4.0.0`](https://togithub.com/typedoc2md/typedoc-plugin-markdown/blob/HEAD/packages/typedoc-plugin-markdown/CHANGELOG.md#400-2024-05-03) [Compare Source](https://togithub.com/typedoc2md/typedoc-plugin-markdown/compare/typedoc-plugin-markdown@3.17.1...typedoc-plugin-markdown@4.0.0) > 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](https://togithub.com/typedoc2md/typedoc-plugin-markdown/issues/581)). - [@experimental](https://togithub.com/experimental) / [@internal](https://togithub.com/internal) annotations. ([#556](https://togithub.com/typedoc2md/typedoc-plugin-markdown/issues/556)) - Fix events output and strike-through deprecated items. ([#534](https://togithub.com/typedoc2md/typedoc-plugin-markdown/issues/534)) - Class static functions are no longer marked. ([#533](https://togithub.com/typedoc2md/typedoc-plugin-markdown/issues/533)) - [@example](https://togithub.com/example) block not rendered with Headline ([#501](https://togithub.com/typedoc2md/typedoc-plugin-markdown/issues/501)) - Support for categories ([#499](https://togithub.com/typedoc2md/typedoc-plugin-markdown/issues/499)) - Correctly resolve package readme urls from member pages. ([#483](https://togithub.com/typedoc2md/typedoc-plugin-markdown/issues/483)) - Add the ability to add a separate frontmatter for readme file. ([#469](https://togithub.com/typedoc2md/typedoc-plugin-markdown/issues/469)) - Items in tables are not linkable. ([#463](https://togithub.com/typedoc2md/typedoc-plugin-markdown/issues/463)) - Custom i18n texts. ([#458](https://togithub.com/typedoc2md/typedoc-plugin-markdown/issues/458)) - How to improve the formatting for types?. ([#456](https://togithub.com/typedoc2md/typedoc-plugin-markdown/issues/456)) - How to change title format. ([#450](https://togithub.com/typedoc2md/typedoc-plugin-markdown/issues/450)) - Export Docusaurus plugin options type. ([#440](https://togithub.com/typedoc2md/typedoc-plugin-markdown/issues/440)) - How to export interface as a table. ([#403](https://togithub.com/typedoc2md/typedoc-plugin-markdown/issues/403)) - Broken Link caused by Typescript class being defined in an index file. ([#402](https://togithub.com/typedoc2md/typedoc-plugin-markdown/issues/403)) - Markdown plugin inserts unnecessary escape characters. ([#398](https://togithub.com/typedoc2md/typedoc-plugin-markdown/issues/398)) - Potential bug with optional function argument. ([#396](https://togithub.com/typedoc2md/typedoc-plugin-markdown/issues/396)) - Respect monorepo `readmeFile` configuration ([#383](https://togithub.com/typedoc2md/typedoc-plugin-markdown/issues/383)) - Embed all objects under a Module/Namespace onto single page. ([#338](https://togithub.com/typedoc2md/typedoc-plugin-markdown/issues/338)) - Extra spaces when merging lines in a table. ([#331](https://togithub.com/typedoc2md/typedoc-plugin-markdown/issues/331)) - Does not support namespace (or module) and interface with same name. ([#300](https://togithub.com/typedoc2md/typedoc-plugin-markdown/issues/300)) - Integration with VitePress? ([#287](https://togithub.com/typedoc2md/typedoc-plugin-markdown/issues/287)) - Typedoc comments with text wrapped in `<` and `>` breaks Docusaurus Markdown parser. ([#276](https://togithub.com/typedoc2md/typedoc-plugin-markdown/issues/276)) - Navigation support? ([#262](https://togithub.com/typedoc2md/typedoc-plugin-markdown/issues/262)) - Sidebar Category Support? ([#213](https://togithub.com/typedoc2md/typedoc-plugin-markdown/issues/213)) - Properties as Table like function properties. ([#109](https://togithub.com/typedoc2md/typedoc-plugin-markdown/issues/109)) - Provide a link/excerpt/screenshot to a demo/example rendered output ([#102](https://togithub.com/typedoc2md/typedoc-plugin-markdown/issues/102)) *** Earlier changelog entries can be found in `CHANGELOG_ARCHIVE.md`. ### [`v3.17.1`](https://togithub.com/typedoc2md/typedoc-plugin-markdown/releases/tag/typedoc-plugin-markdown%403.17.1) [Compare Source](https://togithub.com/typedoc2md/typedoc-plugin-markdown/compare/typedoc-plugin-markdown@3.17.0...typedoc-plugin-markdown@3.17.1) - Prevent escaping of angle brackets in toc [(#495)](https://togithub.com/tgreyuk/typedoc-plugin-markdown/issues/495) ### [`v3.17.0`](https://togithub.com/typedoc2md/typedoc-plugin-markdown/releases/tag/typedoc-plugin-markdown%403.17.0) [Compare Source](https://togithub.com/typedoc2md/typedoc-plugin-markdown/compare/typedoc-plugin-markdown@3.16.0...typedoc-plugin-markdown@3.17.0) #### Features - Support MDXv2 ### [`v3.16.0`](https://togithub.com/typedoc2md/typedoc-plugin-markdown/releases/tag/typedoc-plugin-markdown%403.16.0) [Compare Source](https://togithub.com/typedoc2md/typedoc-plugin-markdown/compare/typedoc-plugin-markdown@3.15.4...typedoc-plugin-markdown@3.16.0) - TypeDoc 0.25.0 compatibility fixes ### [`v3.15.4`](https://togithub.com/typedoc2md/typedoc-plugin-markdown/releases/tag/typedoc-plugin-markdown%403.15.4) [Compare Source](https://togithub.com/typedoc2md/typedoc-plugin-markdown/compare/7ece46d49ac7932c9b7c49be6a9cead824015ec4...typedoc-plugin-markdown@3.15.4) #### Fixes - Split out comment summary and tags for signatures ([#451](https://togithub.com/typedoc2md/typedoc-plugin-markdown/issues/451)) .Configuration
📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
â™» Rebasing: Whenever PR is behind base branch, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about this update again.
This PR has been generated by Mend Renovate. View repository job log here.