使用markdownlint规范Markdown文档 #5126
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
|
Thanks for your contribution! |
|
|
|
你好，请问已经加入微信群了吗？可以在群里@我 |
Closed
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.
现状
PaddleOCR中几乎所有的Markdown文档都不规范（没有符合markdownlint标准），如下图所示。
为什么要符合规范
规范的代码对于一个项目的重要性是不言而喻的，同样Markdown文档也需要符合规范。
我坚决不允许这么优秀的开源项目的文档写得不规范！！！
解决方法
我这次只把
doc/doc_ch/customize.md文档规范了，如果贵项目也觉得有必要规范一下文档，那么我们可以一起进行文档的规范化工作。