[Fix] Fix lint issues in Markdown.
@keli-wen is already working on this.
Since Feb 2, 2025.
Assessment
This issue has not been assessed yet.
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:
xxxx
- xx
- yy
should be modified to:
xxxx
- xx
- yy
to render correctly.
Based on this, I want to:
- use
markdownlintto fix some obvious problems and - add an automated markdown lint checker in the future.
I found the issue when I read the #39.
- Dominant language
- No language data
- Stars
- 4.3k
- Forks
- 338
- PR merge metrics
- No merged PRs in 30d
Getting set up
- No Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing 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.
More from LLMQuant/quant-wiki
-
[内容有误] pdf图书链接全部爆掉Open
Difficulty 3/5 1-2 days Newbie friendliness 50/100
LLMQuant/quant-wiki#124 ·
-
[内容有误] 研报精选pdf全部丢失Open
Difficulty 2/5 1-3 hours Newbie friendliness 55/100
LLMQuant/quant-wiki#123 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 45/100
LLMQuant/quant-wiki#122 ·
-
[内容有误]Open
Difficulty 1/5 Under an hour Newbie friendliness 40/100
LLMQuant/quant-wiki#116 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 58/100
LLMQuant/quant-wiki#114 · 1 comment ·