docs/contributor/markdown_linting.md

Markdown linting

Since the introduction of PR #1309, the markdown files in this repository are checked by a linter for formatting and consistency.

The linter used is markdownlint and can be installed locally on your machine. It can also be setup as pre-commit hook to ensure that your markdown is passing all the tests.

The rules in place are defined here.

You may run markdownlint locally using:

markdownlint --config .github/.markdownlint.yaml --ignore target .

There are also plugins for your favorite editor, that can ensure that most of the rules will pass and fix typical issues (such as trailing spaces, missing eof new line, long lines, etc...)