Skip to content

Commit 83a3eb2

Browse files
authored
Give a code sample with more context for package.json (#44)
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.
1 parent ab68291 commit 83a3eb2

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

README.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,10 @@ See [`markdownlint` rules](https://github.com/DavidAnson/markdownlint#rules--ali
3737

3838
3. Add/modify your linting script in `package.json`.
3939

40-
```bash
41-
markdownlint-cli2 \"**/*.{md,mdx}\" \"!node_modules\"
40+
```json
41+
"scripts": {
42+
"lint:markdown": "markdownlint-cli2 \"**/*.{md,mdx}\" \"!node_modules\""
43+
}
4244
```
4345

4446
4. Edit `.markdownlint-cli2.cjs` file to suit your needs. Start with

0 commit comments

Comments
 (0)