Add markdown linter offline usage to CONTRIBUTING

rust-unofficial / patterns

A catalogue of Rust design patterns, anti-patterns and idioms

https://rust-unofficial.github.io/patterns/

Mozilla Public License 2.0

7.95k stars 362 forks source link

Add markdown linter offline usage to CONTRIBUTING #167

Closed simonsan closed 3 years ago

simonsan commented 3 years ago

Due to #164 we are now checking markdown style in PRs. To make it easier for people to contribute, we should also document in CONTRIBUTING.md how people can actually install, lint offline and apply the fixes automatically.

npm install -g markdownlint-cli
markdownlint -f **/*.md
markdownlint -f *.md

MarcoIeni commented 3 years ago

I am not it.