diff --git a/docs/guides/getting-started.md b/docs/guides/getting-started.md index f701a63cfb..74ca73872b 100644 --- a/docs/guides/getting-started.md +++ b/docs/guides/getting-started.md @@ -7,23 +7,19 @@ Install `@commitlint/cli` and a `@commitlint/config-*` / `commitlint-config-*` o ::: code-group ```sh [npm] -npm install --save-dev @commitlint/{cli,config-conventional} +npm install -D @commitlint/cli @commitlint/config-conventional ``` ```sh [yarn] -yarn add --dev @commitlint/{cli,config-conventional} -``` - -```sh [npm (Windows)] -npm install --save-dev @commitlint/config-conventional @commitlint/cli +yarn add -D @commitlint/cli @commitlint/config-conventional ``` ```sh [pnpm] -pnpm add --save-dev @commitlint/{cli,config-conventional} +pnpm add -D @commitlint/cli @commitlint/config-conventional ``` ```sh [deno] -deno add --dev npm:@commitlint/cli npm:@commitlint/config-conventional +deno add -D npm:@commitlint/cli npm:@commitlint/config-conventional ``` ::: diff --git a/docs/guides/use-prompt.md b/docs/guides/use-prompt.md index cd1bdda4d5..4c587ece12 100644 --- a/docs/guides/use-prompt.md +++ b/docs/guides/use-prompt.md @@ -19,7 +19,7 @@ 3. Install and configure if needed ```sh - npm install --save-dev @commitlint/{cli,config-conventional,prompt-cli} + npm install --save-dev @commitlint/cli @commitlint/config-conventional @commitlint/prompt-cli echo "export default { extends: ['@commitlint/config-conventional'] };" > commitlint.config.js ``` diff --git a/docs/reference/examples.md b/docs/reference/examples.md index 3832adbb1f..773b4048ab 100644 --- a/docs/reference/examples.md +++ b/docs/reference/examples.md @@ -7,16 +7,18 @@ These examples show common usages of how commitlint can be configured. ::: code-group ```jsonc [package.json] +{ // ... - commitlint: { + "commitlint": { "rules": { - "references-empty": [2, "never"] + "references-empty": [2, "never"], }, "parserPreset": { "parserOpts": { - "issuePrefixes": ["PROJ-"] - } - } - } + "issuePrefixes": ["PROJ-"], + }, + }, + }, // ... +} ```