docs: cleanup markdown warnings #29511
Merged
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
- Lists should be surrounded by blank lines. - Fenced code blocks should have a language specified. - Multiple consecutive blank lines. - No trailing punctuation in heading - Headings should be surrounded by blank lines. - Fenced code blocks should be surrounded by blank lines.
|
Love it! Running CI. I also wonder if it's possible to add eslint config for this, so that they're automatically kept clean from these sorts of things. |
|
It might get a bit challenging since some warnings like inline HTML are still there and I didn't want to touch them (do we want to remove them all?) but it would be interesting. |
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.
This will clean the markdown warnings in the docs: