-
Notifications
You must be signed in to change notification settings - Fork 173
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.
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
fix: check markdown grammar issues #665
Conversation
Codecov Report
@@ Coverage Diff @@
## main #665 +/- ##
=======================================
Coverage 60.93% 60.93%
=======================================
Files 120 120
Lines 6384 6384
=======================================
Hits 3890 3890
Misses 2121 2121
Partials 373 373 Continue to review full report at Codecov.
|
Looks good to me overall. Thanks ! @leemos-xx How about adding rules MD01,MD037 and MD038 ? |
Ok, I have added the check for MD001, MD037 and MD038. |
Review process:
|
Co-authored-by: seeflood <zhou.qunli@foxmail.com>
Signed-off-by: seeflood <zhou.qunli@foxmail.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
lgtm.
@Xunzhuo Could u help review this PR?
LGTM, thanks @leemos-xx |
What this PR does:
让CI自动检查markdown的语法,目前使用markdownlint来实现,考虑到贡献者体验和已知的因格式原因导致的渲染问题,现在仅开放对
MD031 - Fenced code blocks should be surrounded by blank lines
规则的校验,后续可以视情况逐步放开。Which issue(s) this PR fixes:
Fixes #622