Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[chore][docs] enable more Markdown lint rules #3088

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

[chore][docs] enable more Markdown lint rules #3088

wants to merge 1 commit into from
+95 −20

Conversation

davidxia
Copy link
Contributor

  • MD025: Multiple top level headers in the same document
  • MD026: Trailing punctuation in header
  • MD031: Fenced code blocks should be surrounded by blank lines
  • MD032: Lists should be surrounded by blank lines

@davidxia
[chore][docs] enable more Markdown lint rules
85ae54e 
* MD025: Multiple top level headers in the same document
* MD026: Trailing punctuation in header
* MD031: Fenced code blocks should be surrounded by blank lines
* MD032: Lists should be surrounded by blank lines

https://github.com/markdownlint/markdownlint/blob/main/docs/RULES.md

Signed-off-by: David Xia <[email protected]>
cchung100m
cchung100m approved these changes Feb 22, 2025
View reviewed changes
Copy link
Contributor

@cchung100m cchung100m left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks to @davidxia 😄

@davidxia davidxia marked this pull request as ready for review February 22, 2025 16:29
@davidxia
Copy link
Contributor Author

build failure looks unrelated

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@cchung100m cchung100m cchung100m approved these changes

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@davidxia @cchung100m