typedoc2md/typedoc-plugin-markdown (typedoc-plugin-markdown)
### [`v4.2.6`](https://togithub.com/typedoc2md/typedoc-plugin-markdown/blob/HEAD/packages/typedoc-plugin-markdown/CHANGELOG.md#426-2024-08-25)
[Compare Source](https://togithub.com/typedoc2md/typedoc-plugin-markdown/compare/typedoc-plugin-markdown@4.2.5...typedoc-plugin-markdown@4.2.6)
##### Patch Changes
- Expose missing entrypoints to navigation ([#663](https://togithub.com/typedoc2md/typedoc-plugin-markdown/issues/663))
- Fix missing function descriptions in indexes
### [`v4.2.5`](https://togithub.com/typedoc2md/typedoc-plugin-markdown/blob/HEAD/packages/typedoc-plugin-markdown/CHANGELOG.md#425-2024-08-15)
[Compare Source](https://togithub.com/typedoc2md/typedoc-plugin-markdown/compare/typedoc-plugin-markdown@4.2.4...typedoc-plugin-markdown@4.2.5)
##### Patch Changes
- Expose comment for arrow functions in type declarations ([#670](https://togithub.com/typedoc2md/typedoc-plugin-markdown/issues/670))
- Tables generated with the "htmlTable" key will include `` and `` elements to fix MDX compatibility issues ([#671](https://togithub.com/typedoc2md/typedoc-plugin-markdown/issues/671))
- Expose missing descriptions with accessor keyword ([#664](https://togithub.com/typedoc2md/typedoc-plugin-markdown/issues/664))
### [`v4.2.4`](https://togithub.com/typedoc2md/typedoc-plugin-markdown/blob/HEAD/packages/typedoc-plugin-markdown/CHANGELOG.md#424-2024-08-13)
[Compare Source](https://togithub.com/typedoc2md/typedoc-plugin-markdown/compare/typedoc-plugin-markdown@4.2.3...typedoc-plugin-markdown@4.2.4)
##### Patch Changes
- Expose comments to reflections with the accessor keyword ([#664](https://togithub.com/typedoc2md/typedoc-plugin-markdown/issues/664))
- Omit constructors from category groups ([#661](https://togithub.com/typedoc2md/typedoc-plugin-markdown/issues/661))
- Update categories structure in navigation to match interface model
### [`v4.2.3`](https://togithub.com/typedoc2md/typedoc-plugin-markdown/blob/HEAD/packages/typedoc-plugin-markdown/CHANGELOG.md#423-2024-07-24)
[Compare Source](https://togithub.com/typedoc2md/typedoc-plugin-markdown/compare/typedoc-plugin-markdown@4.2.2...typedoc-plugin-markdown@4.2.3)
##### Patch Changes
- Fix missing return comments for const functions ([#656](https://togithub.com/typedoc2md/typedoc-plugin-markdown/issues/656))
### [`v4.2.2`](https://togithub.com/typedoc2md/typedoc-plugin-markdown/blob/HEAD/packages/typedoc-plugin-markdown/CHANGELOG.md#422-2024-07-22)
[Compare Source](https://togithub.com/typedoc2md/typedoc-plugin-markdown/compare/typedoc-plugin-markdown@4.2.1...typedoc-plugin-markdown@4.2.2)
##### Patch Changes
- Correctly resolve comment summary for const functions ([#656](https://togithub.com/typedoc2md/typedoc-plugin-markdown/issues/656))
- Fix anchor links containing generics ([#655](https://togithub.com/typedoc2md/typedoc-plugin-markdown/issues/655))
### [`v4.2.1`](https://togithub.com/typedoc2md/typedoc-plugin-markdown/blob/HEAD/packages/typedoc-plugin-markdown/CHANGELOG.md#421-2024-07-11)
[Compare Source](https://togithub.com/typedoc2md/typedoc-plugin-markdown/compare/typedoc-plugin-markdown@4.2.0...typedoc-plugin-markdown@4.2.1)
##### Patch Changes
- Fix missing index descriptions for signatures ([#618](https://togithub.com/typedoc2md/typedoc-plugin-markdown/issues/618))
### [`v4.2.0`](https://togithub.com/typedoc2md/typedoc-plugin-markdown/blob/HEAD/packages/typedoc-plugin-markdown/CHANGELOG.md#420-2024-07-10)
[Compare Source](https://togithub.com/typedoc2md/typedoc-plugin-markdown/compare/typedoc-plugin-markdown@4.1.2...typedoc-plugin-markdown@4.2.0)
##### Minor Changes
- Exposed "modulesFileName" option ([#647](https://togithub.com/typedoc2md/typedoc-plugin-markdown/issues/647))
- Write `.nojekyll` file if TypeDocs "githubPages" option is true ([#650](https://togithub.com/typedoc2md/typedoc-plugin-markdown/issues/650))
- Exposed "blockTagsPreserveOrder" option to configure ordering of comment block tags ([#627](https://togithub.com/typedoc2md/typedoc-plugin-markdown/issues/627)).
- Exposed "useHTMLEncodedBrackets" option for alternative angle bracket escaping([#564](https://togithub.com/typedoc2md/typedoc-plugin-markdown/issues/564)).
### [`v4.1.2`](https://togithub.com/typedoc2md/typedoc-plugin-markdown/blob/HEAD/packages/typedoc-plugin-markdown/CHANGELOG.md#412-2024-07-05)
[Compare Source](https://togithub.com/typedoc2md/typedoc-plugin-markdown/compare/typedoc-plugin-markdown@4.1.1...typedoc-plugin-markdown@4.1.2)
##### Patch Changes
- Support TypeDoc 0.26 relative links implementation ([#645](https://togithub.com/typedoc2md/typedoc-plugin-markdown/issues/645)).
### [`v4.1.1`](https://togithub.com/typedoc2md/typedoc-plugin-markdown/blob/HEAD/packages/typedoc-plugin-markdown/CHANGELOG.md#411-2024-06-30)
[Compare Source](https://togithub.com/typedoc2md/typedoc-plugin-markdown/compare/typedoc-plugin-markdown@4.1.0...typedoc-plugin-markdown@4.1.1)
##### Patch Changes
- Normalize window paths when "publicPath" is set ([#639](https://togithub.com/typedoc2md/typedoc-plugin-markdown/issues/639))
### [`v4.1.0`](https://togithub.com/typedoc2md/typedoc-plugin-markdown/blob/HEAD/packages/typedoc-plugin-markdown/CHANGELOG.md#410-2024-06-22)
[Compare Source](https://togithub.com/typedoc2md/typedoc-plugin-markdown/compare/typedoc-plugin-markdown@4.0.3...typedoc-plugin-markdown@4.1.0)
##### 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](https://togithub.com/typedoc2md/typedoc-plugin-markdown/issues/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](https://togithub.com/typedoc2md/typedoc-plugin-markdown/issues/625))
- Fix issues with tables and block tags ([#618](https://togithub.com/typedoc2md/typedoc-plugin-markdown/issues/618))
### [`v4.0.3`](https://togithub.com/typedoc2md/typedoc-plugin-markdown/blob/HEAD/packages/typedoc-plugin-markdown/CHANGELOG.md#403-2024-05-27)
[Compare Source](https://togithub.com/typedoc2md/typedoc-plugin-markdown/compare/typedoc-plugin-markdown@4.0.2...typedoc-plugin-markdown@4.0.3)
##### Patch Changes
- Remove superfluous quotes from prop names ([#619](https://togithub.com/typedoc2md/typedoc-plugin-markdown/issues/619))
- Fix display of index descriptions in tables ([#618](https://togithub.com/typedoc2md/typedoc-plugin-markdown/issues/618))
### [`v4.0.2`](https://togithub.com/typedoc2md/typedoc-plugin-markdown/blob/HEAD/packages/typedoc-plugin-markdown/CHANGELOG.md#402-2024-05-15)
[Compare Source](https://togithub.com/typedoc2md/typedoc-plugin-markdown/compare/typedoc-plugin-markdown@4.0.1...typedoc-plugin-markdown@4.0.2)
##### Patch Changes
- Fix symbol url anchors when "flattenOutputFiles" is "true" ([#616](https://togithub.com/typedoc2md/typedoc-plugin-markdown/issues/616))
- Normalize line breaks and tags within table columns ([#615](https://togithub.com/typedoc2md/typedoc-plugin-markdown/issues/615))
- Remove superfluous spaces and symbol on external links ([#614](https://togithub.com/typedoc2md/typedoc-plugin-markdown/issues/614))
- Escape all angle brackets with "santizeComments" ([#612](https://togithub.com/typedoc2md/typedoc-plugin-markdown/issues/612))
- Correctly handle quoted symbol names ([#611](https://togithub.com/typedoc2md/typedoc-plugin-markdown/issues/611))
- Correctly handle excludeScopesInPaths in windows ([#610](https://togithub.com/typedoc2md/typedoc-plugin-markdown/issues/610))
### [`v4.0.1`](https://togithub.com/typedoc2md/typedoc-plugin-markdown/blob/HEAD/packages/typedoc-plugin-markdown/CHANGELOG.md#401-2024-05-07)
[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.
##### New 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))
Configuration
📅 Schedule: Branch creation - "after 10pm every weekday,before 5am every weekday,every weekend" in timezone Europe/Moscow, Automerge - At any time (no schedule defined).
🚦 Automerge: Enabled.
♻ 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.
[ ] If you want to rebase/retry this PR, check this box
Install scripts are run when the package is installed. The majority of malware in npm is hidden in install scripts.
Packages should not be running non-essential scripts during install and there are often solutions to problems people solve with install scripts that can be run at publish time instead.
What is a typosquat?
Package name is similar to other popular packages and may not be the package you want.
Use care when consuming similarly named packages and ensure that you did not intend to consume a different package. Malicious packages often publish using similar names as existing popular packages.
Take a deeper look at the dependency
Take a moment to review the security alert above. Review the linked
package source code to understand the potential risk. Ensure the package
is not malicious before proceeding. If you're unsure how to proceed, reach
out to your security team or ask the Socket team for help at support [AT]
socket [DOT] dev.
Remove the package
If you happen to install a dependency that Socket reports as Known Malware you should immediately remove it and select a different dependency. For other alert types, you may may wish to investigate alternative packages or consider if there are other ways to mitigate the specific risk posed by the dependency.
Mark a package as acceptable risk
To ignore an alert, reply with a comment starting with @SocketSecurity ignore followed by a space separated list of ecosystem/package-name@version specifiers. e.g. @SocketSecurity ignore npm/foo@1.0.0 or ignore all packages with @SocketSecurity ignore-all
This PR contains the following updates:
^3.10.2
->^4.0.0
Release Notes
typedoc2md/typedoc-plugin-markdown (typedoc-plugin-markdown)
### [`v4.2.6`](https://togithub.com/typedoc2md/typedoc-plugin-markdown/blob/HEAD/packages/typedoc-plugin-markdown/CHANGELOG.md#426-2024-08-25) [Compare Source](https://togithub.com/typedoc2md/typedoc-plugin-markdown/compare/typedoc-plugin-markdown@4.2.5...typedoc-plugin-markdown@4.2.6) ##### Patch Changes - Expose missing entrypoints to navigation ([#663](https://togithub.com/typedoc2md/typedoc-plugin-markdown/issues/663)) - Fix missing function descriptions in indexes ### [`v4.2.5`](https://togithub.com/typedoc2md/typedoc-plugin-markdown/blob/HEAD/packages/typedoc-plugin-markdown/CHANGELOG.md#425-2024-08-15) [Compare Source](https://togithub.com/typedoc2md/typedoc-plugin-markdown/compare/typedoc-plugin-markdown@4.2.4...typedoc-plugin-markdown@4.2.5) ##### Patch Changes - Expose comment for arrow functions in type declarations ([#670](https://togithub.com/typedoc2md/typedoc-plugin-markdown/issues/670)) - Tables generated with the "htmlTable" key will include `` and `` elements to fix MDX compatibility issues ([#671](https://togithub.com/typedoc2md/typedoc-plugin-markdown/issues/671)) - Expose missing descriptions with accessor keyword ([#664](https://togithub.com/typedoc2md/typedoc-plugin-markdown/issues/664)) ### [`v4.2.4`](https://togithub.com/typedoc2md/typedoc-plugin-markdown/blob/HEAD/packages/typedoc-plugin-markdown/CHANGELOG.md#424-2024-08-13) [Compare Source](https://togithub.com/typedoc2md/typedoc-plugin-markdown/compare/typedoc-plugin-markdown@4.2.3...typedoc-plugin-markdown@4.2.4) ##### Patch Changes - Expose comments to reflections with the accessor keyword ([#664](https://togithub.com/typedoc2md/typedoc-plugin-markdown/issues/664)) - Omit constructors from category groups ([#661](https://togithub.com/typedoc2md/typedoc-plugin-markdown/issues/661)) - Update categories structure in navigation to match interface model ### [`v4.2.3`](https://togithub.com/typedoc2md/typedoc-plugin-markdown/blob/HEAD/packages/typedoc-plugin-markdown/CHANGELOG.md#423-2024-07-24) [Compare Source](https://togithub.com/typedoc2md/typedoc-plugin-markdown/compare/typedoc-plugin-markdown@4.2.2...typedoc-plugin-markdown@4.2.3) ##### Patch Changes - Fix missing return comments for const functions ([#656](https://togithub.com/typedoc2md/typedoc-plugin-markdown/issues/656)) ### [`v4.2.2`](https://togithub.com/typedoc2md/typedoc-plugin-markdown/blob/HEAD/packages/typedoc-plugin-markdown/CHANGELOG.md#422-2024-07-22) [Compare Source](https://togithub.com/typedoc2md/typedoc-plugin-markdown/compare/typedoc-plugin-markdown@4.2.1...typedoc-plugin-markdown@4.2.2) ##### Patch Changes - Correctly resolve comment summary for const functions ([#656](https://togithub.com/typedoc2md/typedoc-plugin-markdown/issues/656)) - Fix anchor links containing generics ([#655](https://togithub.com/typedoc2md/typedoc-plugin-markdown/issues/655)) ### [`v4.2.1`](https://togithub.com/typedoc2md/typedoc-plugin-markdown/blob/HEAD/packages/typedoc-plugin-markdown/CHANGELOG.md#421-2024-07-11) [Compare Source](https://togithub.com/typedoc2md/typedoc-plugin-markdown/compare/typedoc-plugin-markdown@4.2.0...typedoc-plugin-markdown@4.2.1) ##### Patch Changes - Fix missing index descriptions for signatures ([#618](https://togithub.com/typedoc2md/typedoc-plugin-markdown/issues/618)) ### [`v4.2.0`](https://togithub.com/typedoc2md/typedoc-plugin-markdown/blob/HEAD/packages/typedoc-plugin-markdown/CHANGELOG.md#420-2024-07-10) [Compare Source](https://togithub.com/typedoc2md/typedoc-plugin-markdown/compare/typedoc-plugin-markdown@4.1.2...typedoc-plugin-markdown@4.2.0) ##### Minor Changes - Exposed "modulesFileName" option ([#647](https://togithub.com/typedoc2md/typedoc-plugin-markdown/issues/647)) - Write `.nojekyll` file if TypeDocs "githubPages" option is true ([#650](https://togithub.com/typedoc2md/typedoc-plugin-markdown/issues/650)) - Exposed "blockTagsPreserveOrder" option to configure ordering of comment block tags ([#627](https://togithub.com/typedoc2md/typedoc-plugin-markdown/issues/627)). - Exposed "useHTMLEncodedBrackets" option for alternative angle bracket escaping([#564](https://togithub.com/typedoc2md/typedoc-plugin-markdown/issues/564)). ### [`v4.1.2`](https://togithub.com/typedoc2md/typedoc-plugin-markdown/blob/HEAD/packages/typedoc-plugin-markdown/CHANGELOG.md#412-2024-07-05) [Compare Source](https://togithub.com/typedoc2md/typedoc-plugin-markdown/compare/typedoc-plugin-markdown@4.1.1...typedoc-plugin-markdown@4.1.2) ##### Patch Changes - Support TypeDoc 0.26 relative links implementation ([#645](https://togithub.com/typedoc2md/typedoc-plugin-markdown/issues/645)). ### [`v4.1.1`](https://togithub.com/typedoc2md/typedoc-plugin-markdown/blob/HEAD/packages/typedoc-plugin-markdown/CHANGELOG.md#411-2024-06-30) [Compare Source](https://togithub.com/typedoc2md/typedoc-plugin-markdown/compare/typedoc-plugin-markdown@4.1.0...typedoc-plugin-markdown@4.1.1) ##### Patch Changes - Normalize window paths when "publicPath" is set ([#639](https://togithub.com/typedoc2md/typedoc-plugin-markdown/issues/639)) ### [`v4.1.0`](https://togithub.com/typedoc2md/typedoc-plugin-markdown/blob/HEAD/packages/typedoc-plugin-markdown/CHANGELOG.md#410-2024-06-22) [Compare Source](https://togithub.com/typedoc2md/typedoc-plugin-markdown/compare/typedoc-plugin-markdown@4.0.3...typedoc-plugin-markdown@4.1.0) ##### 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](https://togithub.com/typedoc2md/typedoc-plugin-markdown/issues/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](https://togithub.com/typedoc2md/typedoc-plugin-markdown/issues/625)) - Fix issues with tables and block tags ([#618](https://togithub.com/typedoc2md/typedoc-plugin-markdown/issues/618)) ### [`v4.0.3`](https://togithub.com/typedoc2md/typedoc-plugin-markdown/blob/HEAD/packages/typedoc-plugin-markdown/CHANGELOG.md#403-2024-05-27) [Compare Source](https://togithub.com/typedoc2md/typedoc-plugin-markdown/compare/typedoc-plugin-markdown@4.0.2...typedoc-plugin-markdown@4.0.3) ##### Patch Changes - Remove superfluous quotes from prop names ([#619](https://togithub.com/typedoc2md/typedoc-plugin-markdown/issues/619)) - Fix display of index descriptions in tables ([#618](https://togithub.com/typedoc2md/typedoc-plugin-markdown/issues/618)) ### [`v4.0.2`](https://togithub.com/typedoc2md/typedoc-plugin-markdown/blob/HEAD/packages/typedoc-plugin-markdown/CHANGELOG.md#402-2024-05-15) [Compare Source](https://togithub.com/typedoc2md/typedoc-plugin-markdown/compare/typedoc-plugin-markdown@4.0.1...typedoc-plugin-markdown@4.0.2) ##### Patch Changes - Fix symbol url anchors when "flattenOutputFiles" is "true" ([#616](https://togithub.com/typedoc2md/typedoc-plugin-markdown/issues/616)) - Normalize line breaks and tags within table columns ([#615](https://togithub.com/typedoc2md/typedoc-plugin-markdown/issues/615)) - Remove superfluous spaces and symbol on external links ([#614](https://togithub.com/typedoc2md/typedoc-plugin-markdown/issues/614)) - Escape all angle brackets with "santizeComments" ([#612](https://togithub.com/typedoc2md/typedoc-plugin-markdown/issues/612)) - Correctly handle quoted symbol names ([#611](https://togithub.com/typedoc2md/typedoc-plugin-markdown/issues/611)) - Correctly handle excludeScopesInPaths in windows ([#610](https://togithub.com/typedoc2md/typedoc-plugin-markdown/issues/610)) ### [`v4.0.1`](https://togithub.com/typedoc2md/typedoc-plugin-markdown/blob/HEAD/packages/typedoc-plugin-markdown/CHANGELOG.md#401-2024-05-07) [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. ##### New 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))Configuration
📅 Schedule: Branch creation - "after 10pm every weekday,before 5am every weekday,every weekend" in timezone Europe/Moscow, Automerge - At any time (no schedule defined).
🚦 Automerge: Enabled.
♻ 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 was generated by Mend Renovate. View the repository job log.
Branch automerge failure
This PR was configured for branch automerge. However, this is not possible, so it has been raised as a PR instead.
New and removed dependencies detected. Learn more about Socket for GitHub ↗︎
0
0
+1
0
0
+1
+1
+1
0
0
+1
+1
+1
0
0
0
0
0
0
0
0
0
0
0
+3
0
0
+1
0
+1
0
+1
0
0
+3
0
0
0
0
0
0
0
0
0
0
0
+1
0
0
+1
+2
0
+1
0
0
+16
+3
+2
0
0
+1
0
0
+1
+2
+1
0
0
0
🚮 Removed packages: npm/is-regex@1.1.4, npm/js-sha256@0.9.0, npm/js-yaml@4.1.0, npm/mime-types@2.1.35, npm/mobx@6.12.3, npm/parse-json@5.2.0, npm/prettier@2.3.2, npm/slugify@1.6.6, npm/threads@1.6.5, npm/tiny-worker@2.3.0
View full report↗︎
🚨 Potential security issues detected. Learn more about Socket for GitHub ↗︎
To accept the risk, merge this PR and you will not be notified again.
node postinstall.js
package.json
node-pre-gyp install --fallback-to-build
package.json
package.json
View full report↗︎
Next steps
What is an install script?
Install scripts are run when the package is installed. The majority of malware in npm is hidden in install scripts.
Packages should not be running non-essential scripts during install and there are often solutions to problems people solve with install scripts that can be run at publish time instead.
What is a typosquat?
Package name is similar to other popular packages and may not be the package you want.
Use care when consuming similarly named packages and ensure that you did not intend to consume a different package. Malicious packages often publish using similar names as existing popular packages.
Take a deeper look at the dependency
Take a moment to review the security alert above. Review the linked package source code to understand the potential risk. Ensure the package is not malicious before proceeding. If you're unsure how to proceed, reach out to your security team or ask the Socket team for help at support [AT] socket [DOT] dev.
Remove the package
If you happen to install a dependency that Socket reports as Known Malware you should immediately remove it and select a different dependency. For other alert types, you may may wish to investigate alternative packages or consider if there are other ways to mitigate the specific risk posed by the dependency.
Mark a package as acceptable risk
To ignore an alert, reply with a comment starting with
@SocketSecurity ignore
followed by a space separated list ofecosystem/package-name@version
specifiers. e.g.@SocketSecurity ignore npm/foo@1.0.0
or ignore all packages with@SocketSecurity ignore-all
@SocketSecurity ignore npm/@arkweid/lefthook@0.7.7
@SocketSecurity ignore npm/canvas@2.8.0
@SocketSecurity ignore npm/github-url-parse@0.1.0
Thanks for opening an issue! Make sure you've followed CONTRIBUTING.md.
Hello from PR Helper
Is your PR ready for review and processing? Mark the PR ready by including
#pr-ready
in a comment.If you still have work to do, even after marking this ready. Put the PR on hold by including
#pr-onhold
in a comment.Thanks for the PR!
This section of the codebase is owner by https://github.com/AlexRogalskiy/ - if they write a comment saying "LGTM" then it will be merged.