Open
Conversation
## Summary Adds `mdformat` v1.0 as a pre commit hook with the myst plugin. This helps automate formatting of documentation and catch any mistakes in structure or syntax, making docs maintenance easier. ## Scope As a hook with write permissions, it is meant to run locally, not in CI.
C-Achard
added
enhancement
Collaborator
Author
|
One annoyance to note with this : if one has e.g. a technically invalid bullet list which still renders fine(e.g. because of extra newlines), this might try to "fix" it by making every bullet a 1. |
deruyter92
approved these changes
Apr 21, 2026
This was referenced Apr 28, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Summary
mdformatv1.0 as a pre commit hook with the myst plugin. This helps automate formatting of documentation and catch any mistakes in structure or syntax, making docs maintenance easier.Scope