[Docs] Replace markdownlint with mdformat for avoiding installing ruby #1936
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
zhouzaida
changed the title
ZwwWayne
reviewed
May 7, 2022
| hooks: | ||
| - id: mdformat | ||
| args: ["--number"] | ||
| additional_dependencies: |
There was a problem hiding this comment.
some rules are skipped in the original markdownlint, should we also set some rules here to lose some restriction?
There was a problem hiding this comment.
mdformat does not accept those rules to skip checking. Maybe we need to discuss those rules.
There was a problem hiding this comment.
ZwwWayne
reviewed
May 7, 2022
ZwwWayne
reviewed
May 7, 2022
| @@ -2,61 +2,61 @@ | |||
|
|
|||
| <!-- TOC --> | |||
|
|
|||
| - [TensorRT自定义算子](#tensorrt自定义算子) | |||
| - [TensorRT自定义算子](#tensorrt%E8%87%AA%E5%AE%9A%E4%B9%89%E7%AE%97%E5%AD%90) | |||
There was a problem hiding this comment.
this modification is a bit wierd, makes it hard to write Chinese doc.
There was a problem hiding this comment.
I opened an issue at mdformat. executablebooks/mdformat#322
zhouzaida
commented
May 9, 2022
ZwwWayne
approved these changes
May 16, 2022
zhouzaida
changed the title
zhouzaida
changed the title
6 tasks
Merged
6 tasks
7 tasks
wangruohui
pushed a commit
to wangruohui/mmcv
that referenced
this pull request
Jun 11, 2022
open-mmlab#1936) * Use mdformat pre-commit hook * allows consecutive numbering * improve .mdformat.toml * test mdformat * format markdown * minor fix * fix codespecll * fix circleci * add linkify-it-py dependency for cicleci * add comments * replace flake8 url * add mdformat-myst dependency * remove mdformat-myst dependency * update contributing.md
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.
Thanks for your contribution and we appreciate it a lot. The following instructions would make your pull request more healthy and more easily get feedback. If you do not understand some items, don't worry, just make the pull request and seek help from maintainers.
Motivation
Replace markdownlint with mdformat to avoid installing ruby
Modification
docs/*.md
BC-breaking (Optional)
No
Use cases (Optional)
If this PR introduces a new feature, it is better to list some use cases here, and update the documentation.
Checklist
Before PR:
After PR: