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: Add Integration Menu + MegaLinter #915

Merged
merged 2 commits into from
Jan 16, 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 @@ -50,7 +50,7 @@ First thing first, let's make sure you have the necessary pre-requisites.

Quick links

[CLI commands and configuration](https://npmpackagejsonlint.org/docs/cli) | [Node.js API](https://npmpackagejsonlint.org/docs/api)
[CLI commands and configuration](https://npmpackagejsonlint.org/docs/cli) | [Node.js API](https://npmpackagejsonlint.org/docs/api) | [Integrations](https://npmpackagejsonlint.org/docs/integrations)

## Migrating from v5.x.x to 6.x.x

Expand Down
20 changes: 20 additions & 0 deletions website/docs/integrations.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
id: integrations
title: Integrations
---

The following documentation lists applications integrating npm-package-json-lint.

If you are aware of other integrations, please make a pull request !

## Continuous Integration

### MegaLinter

[MegaLinter](https://megalinter.io/) is an Open-Source tool for CI/CD workflows that analyzes the consistency of your code, IAC, configuration, and scripts in your repository, to ensure all your projects sources are clean and formatted whatever IDE/toolbox is used by their developers.

It is free for all uses and [**natively embeds npm-package-json-lint**](https://megalinter.io/latest/descriptors/json_npm_package_json_lint/) within its **100+** linters.

To install it, run `npx mega-linter-runner --install` (requires Node.js >= 16.0)


3 changes: 3 additions & 0 deletions website/i18n/en.json
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,9 @@
"install": {
"title": "Install"
},
"integrations": {
"title": "Integrations"
},
"rcfile-example": {
"title": ".npmpackagejsonlintrc.json example"
},
Expand Down
3 changes: 2 additions & 1 deletion website/sidebars.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,8 @@
"rcfile-example",
"cli",
"api",
"ignore"
"ignore",
"integrations"
],
"Rules": [
"rules"
Expand Down