typedoc2md/typedoc-plugin-markdown (typedoc-plugin-markdown)
### [`v4.0.1`](https://togithub.com/typedoc2md/typedoc-plugin-markdown/blob/HEAD/packages/typedoc-plugin-markdown/CHANGELOG.md#401)
[Compare Source](https://togithub.com/typedoc2md/typedoc-plugin-markdown/compare/typedoc-plugin-markdown@4.0.0...typedoc-plugin-markdown@4.0.1)
##### Patch Changes
- Remove superfluous newlines from table column descriptions ([#591](https://togithub.com/typedoc2md/typedoc-plugin-markdown/issues/591)).
- Handle multiple `@example` tags on same reflection.
- Fix missing extended by definitions.
- Escape Symbols with signatures correctly.
### [`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`.
Configuration
📅 Schedule: Branch creation - "before 9am on monday" (UTC), Automerge - At any time (no schedule defined).
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about this update again.
[ ] If you want to rebase/retry this PR, check this box
This PR has been generated by Mend Renovate. View repository job log here.
This PR contains the following updates:
^3.15.4->^4.0.0Release Notes
typedoc2md/typedoc-plugin-markdown (typedoc-plugin-markdown)
### [`v4.0.1`](https://togithub.com/typedoc2md/typedoc-plugin-markdown/blob/HEAD/packages/typedoc-plugin-markdown/CHANGELOG.md#401) [Compare Source](https://togithub.com/typedoc2md/typedoc-plugin-markdown/compare/typedoc-plugin-markdown@4.0.0...typedoc-plugin-markdown@4.0.1) ##### Patch Changes - Remove superfluous newlines from table column descriptions ([#591](https://togithub.com/typedoc2md/typedoc-plugin-markdown/issues/591)). - Handle multiple `@example` tags on same reflection. - Fix missing extended by definitions. - Escape Symbols with signatures correctly. ### [`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`.Configuration
📅 Schedule: Branch creation - "before 9am on monday" (UTC), Automerge - At any time (no schedule defined).
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
♻ Rebasing: Whenever PR becomes conflicted, 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.