Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Use new Github blockquotes #219

Merged
merged 1 commit into from
Dec 1, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions docs/adding_new_strategy.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
3 changes: 2 additions & 1 deletion docs/github_advisory.md
Original file line number Diff line number Diff line change
Expand Up @@ -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";
Expand Down