Re-enable mdformat for dev-docs - #3386
Merged
Merged
Conversation
deruyter92
force-pushed
the
jaap/fix_mkdocs_mdformat
branch
from
July 7, 2026 09:55
b9f1c5a to
6e7a7ad
Compare
Add comments to explain - the need for two separate entries - the need for [--ignore-missing-references]
deruyter92
force-pushed
the
jaap/fix_mkdocs_mdformat
branch
from
July 7, 2026 09:56
6e7a7ad to
0b9c89f
Compare
C-Achard
reviewed
Jul 7, 2026
C-Achard
approved these changes
Jul 7, 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
3 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.
Re-enable mdformat for dev-docs
Problem
dev-docs/markdown formatting was disabled in pre-commit after mdformat-mkdocs#80: the plugin could rewrite MkDocs autoref links into broken escaped links. This came from #3353, which addeddev-docs/to mdformat and then commented the hook out again because of the aforementioned issue.Fix
Thanks to @KyleKing for
df7394f6and79e245b8(see deruyter92#4):mdformat-mkdocsfordev-docs/**/*.md(pinned to5.2.1)--ignore-missing-referencesso unresolved autoref targets are left alone (mdformat-mkdocs#80)b5fb4519restores two separate hooks —mdformat-mystfordocs/,mdformat-mkdocsfordev-docs/— per hukkin/mdformat#546, with brief comments explaining the split and the--ignore-missing-referencesflag.Related