⬆️ Updates typedoc-plugin-markdown to v4 #2374
Conversation
![renovate[bot]](https://avatars.githubusercontent.com/in/2740?s=60&v=4){kind=small}
Signed-off-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Branch automerge failureThis PR was configured for branch automerge. However, this is not possible, so it has been raised as a PR instead.
|
|
🚨 Potential security issues detected. Learn more about Socket for GitHub ↗︎ To accept the risk, merge this PR and you will not be notified again.
Next stepsWhat 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 dependencyTake 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 packageIf 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 riskTo ignore an alert, reply with a comment starting with
|
|
Thanks for opening an issue! Make sure you've followed CONTRIBUTING.md. |
Hello from PR HelperIs your PR ready for review and processing? Mark the PR ready by including If you still have work to do, even after marking this ready. Put the PR on hold by including |
|
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. |
This PR contains the following updates:
^3.10.2->^4.0.0Release Notes
typedoc2md/typedoc-plugin-markdown (typedoc-plugin-markdown)
v4.0.0Compare Source
Architectural Changes
Features
Structural Changes
--outputFileStrategy. To achieve the same output as v3 (whereby only Classes, Enums and Interfaces have their own file), set the optionmembersWithOwnFileoption.--parametersFormat=table.Breaking Changes
themeto"markdown"is no longer required and should be removed.indexTitlehas been removed. Please use the"title.indexPage"key with option--textContentMappings.allReflectionsHaveOwnDocumenthas been removed (this behaviour is now the default). Please see optionoutputFileStrategy](/docs/options#outputfilestrategy).entryDocumenthas been renamed toentryFileNameto better reflect its purpose.namedAnchorshas been renamed touseHTMLAnchorsto better reflect its purpose.hideInPageTOChas been removed. In-page TOC are no longer included by default. You can include in-page TOCs by usingtypedoc-plugin-remarkand theremark-tocplugin.objectLiteralTypeDeclarationStylehas been removed. Please use option--typeDeclarationFormat=list.Bug Fixes
readmeFileconfiguration (#383)<and>breaks Docusaurus Markdown parser. (#276)Earlier changelog entries can be found in
CHANGELOG_ARCHIVE.md.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 has been generated by Mend Renovate. View repository job log here.