Part of #536. This is the initial step to lint Markdown files in CI. This PR adds a Markdown linter tool, markdownlint-cli2 to pre-commit hook and CI to lint Markdown files. Also adds the configuration file .markdownlint.yaml which allows to change the behavior of the linter. Changes in Markdown files were automatically fixed by pre-commit run markdownlint-cli2-fix --all-files. The linter discovered more than 100 errors. Those errors are suppressed by turning the corresponding checks off in the config file in order to make CI green (this is a temporary solution to add the linter to CI without introducing a big bang change which fixes all of the issues in a single PR). I'll fix the remaining issues in follow-up PRs to turn the disabled checks on.
Part of #536. This is the initial step to lint Markdown files in CI. This PR adds a Markdown linter tool, markdownlint-cli2 to pre-commit hook and CI to lint Markdown files. Also adds the configuration file
.markdownlint.yaml
which allows to change the behavior of the linter. Changes in Markdown files were automatically fixed bypre-commit run markdownlint-cli2-fix --all-files
. The linter discovered more than 100 errors. Those errors are suppressed by turning the corresponding checks off in the config file in order to make CI green (this is a temporary solution to add the linter to CI without introducing a big bang change which fixes all of the issues in a single PR). I'll fix the remaining issues in follow-up PRs to turn the disabled checks on.