-
Chevdor authored
* Add markdown linting - add linter default rules - adapt rules to current code - fix the code for linting to pass - add CI check fix #1243 * Fix markdown for Substrate * Fix tooling install * Fix workflow * Add documentation * Remove trailing spaces * Update .github/.markdownlint.yaml Co-authored-by:Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Fix mangled markdown/lists * Fix captalization issues on known words
Unverifieda30092ab
Code owners
Assign users and groups as approvers for specific file changes. Learn more.
markdown_linting.md 932 B
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...)