Add mdformat to pre-commit config #878
Open
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
References and relevant issues
Closes #821
Description
This PR lints the entire repo. I am using mdformat with myst, and there are some limitations and caveats:
\[) that we don't really need but I guess they don't hurt and the benefit in the end is a net positive (having the linter turned on by default)Most of the motivation for this is to catch syntax issues early before a contributor actually submits a PR or has to build the docs locally.
Run mdformat with pre-commit. This is a test to see how the formatter behaves.