From db32c552431d40bc811005c5fdcea0ebf7ade7d8 Mon Sep 17 00:00:00 2001 From: Kouadio Fabrice N'guessan Date: Fri, 1 Dec 2023 13:14:04 +0000 Subject: [PATCH] chore: Use new Github blockquotes --- README.md | 2 +- docs/adding_new_strategy.md | 4 ++-- docs/github_advisory.md | 3 ++- 3 files changed, 5 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index d75e7e1..959f041 100644 --- a/README.md +++ b/README.md @@ -123,7 +123,7 @@ export interface HydratePayloadDepsOptions extends BaseStrategyOptions { Where `dependencies` is the dependencies **Map()** object of the NodeSecure Scanner. -> [!NOTES] +> [!NOTE] > the option **hydrateDatabase** is only useful for some of the strategy (like Node.js Security WG). ### Standard vulnerability format diff --git a/docs/adding_new_strategy.md b/docs/adding_new_strategy.md index c8d498f..74e4388 100644 --- a/docs/adding_new_strategy.md +++ b/docs/adding_new_strategy.md @@ -144,7 +144,7 @@ export async function hydratePayloadDependencies( ``` --- - -> ⚠️ **Notes**: Documentation and testing are not specified here because it is difficult to predict what is needed. However, you are also responsible for adding them. +> [!WARNING] +> Documentation and testing are not specified here because it is difficult to predict what is needed. However, you are also responsible for adding them. Take an interest in the previous works in `docs/` and `tests/strategies`. diff --git a/docs/github_advisory.md b/docs/github_advisory.md index dac866c..0781501 100644 --- a/docs/github_advisory.md +++ b/docs/github_advisory.md @@ -13,7 +13,8 @@ const { vulnerabilities } = (await arborist.audit()).toJSON(); This strategy doesn't require the synchronization of a local database. -> ⚠️ This strategy currently only work with a local project analysis (with a package.json/package-lock.json) ⚠️ +> [!IMPORTANT] +> This strategy currently only work with a local project analysis (with a package.json/package-lock.json) ```js import * as vulnera from "@nodesecure/vulnera";