Strictly lint markdown in /docs #2897
Closed
Conversation
This file contains 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
SorenSpicknall
requested review from
charlie-costanzo and
lauriemerrell
as code owners
atvaccaro
suggested changes
Aug 17, 2023
There was a problem hiding this comment.
Is there any mechanism to actually enforce these going forward, preferably automatically so users aren't manually fixing markdown? I'm fine with auto-formatting in pre-commit or CI but formatting-only PRs introduce noise unless someone knows how to ignore whitespace changes in git
|
https://github.com/executablebooks/mdformat looks good |
6 tasks
|
Closing in favor of #2906 |
6 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
For folks using common linting tools and linting-related IDE extensions like markdownlint, the existing markdown in our
/docssubfolder is quite noisy. This PR brings that directory much closer to a strict interpretation of markdown rules, without making any content changes.Suggestion for reviewers: double check that the code blocks with newly added annotations are annotated with the correct language. Obviously, this should be on top of visually inspecting the resulting staging version of the docs site for any weird formatting introduced by these changes.
Type of change
How has this been tested?
Markdown linted successfully.
Post-merge follow-ups