LLMQuant / LLMQuant/quant-wiki
[Fix] Fix lint issues in Markdown.
Open
@keli-wen is already working on this.
Since Feb 2, 2025.
enhancement
- Dominant language
- No language data
- Stars
- 4.2k
- Forks
- 336
- PR merge metrics
- No merged PRs in 30d
Description
### Description
The current markdown document has some basic formatting errors. Some of them have no impact, while others will affect the rendering effect. For example:
```markdown
xxxx
- xx
- yy
```
should be modified to:
```markdown
xxxx
- xx
- yy
```
to render correctly.
Based on this, I want to：
- [x] use [`markdownlint`](https://github.com/DavidAnson/markdownlint) to fix some obvious problems and
- [ ] add an automated markdown lint checker in the future.
---
I found the issue when I read the #39.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.