Skip to content

Commit

Permalink
Update markdownlint commands in CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
glen-84 committed May 26, 2024
1 parent cb28038 commit 4350971
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,12 +75,12 @@ There are other available commands too. As set up in the [.build](./.build/) dir

## How to Check the docs

We use [Markdownlint](https://github.com/DavidAnson/markdownlint) to check markdown formatting and [cSpell](https://cspell.org) for spelling. We have GitHub actions to check these for PRs, but if you'd like to check locally, you can:
We use [markdownlint](https://github.com/DavidAnson/markdownlint) to check markdown formatting and [cSpell](https://cspell.org) for spelling. We have GitHub actions to check these for PRs, but if you'd like to check locally, you can:

- Install cSpell: `npm install -g cspell`
- Install the markdownlint CLI: `npm install -g markdownlint-cli`.
- Install the markdownlint CLI: `npm install --global markdownlint-cli2`.
- For spellcheck, run `cspell --config ./cSpell.json "website/src/**/*.md" --no-progress`
- For markdown linting, run `markdownlint "./website/src/**/*.md" --disable MD013`
- For markdown linting, run `markdownlint-cli2 "*.md" "website/src/**/*.md"`

## Code of conduct

Expand Down

0 comments on commit 4350971

Please sign in to comment.