From 821409ef8406b09d8085ce86982e013fd6f3b6a9 Mon Sep 17 00:00:00 2001 From: Sam Partington Date: Fri, 12 May 2023 11:30:42 +0100 Subject: [PATCH] Give a code sample with more context for package.json For developers who don't normally work on node projects, just having the command to invoke doesn't provide enough context as to how to update `package.json`. This change provides a fuller example with more context. --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 5614270..073b602 100644 --- a/README.md +++ b/README.md @@ -37,8 +37,10 @@ See [`markdownlint` rules](https://github.com/DavidAnson/markdownlint#rules--ali 3. Add/modify your linting script in `package.json`. - ```bash - markdownlint-cli2 \"**/*.{md,mdx}\" \"!node_modules\" + ```json + "scripts": { + "lint:markdown": "markdownlint-cli2 \"**/*.{md,mdx}\" \"!node_modules\"" + } ``` 4. Edit `.markdownlint-cli2.cjs` file to suit your needs. Start with