Skip to content
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

Standardize markdown file syntax #698

Closed
tinvaan opened this issue Feb 21, 2024 · 0 comments · Fixed by #695
Closed

Standardize markdown file syntax #698

tinvaan opened this issue Feb 21, 2024 · 0 comments · Fixed by #695

Comments

@tinvaan
Copy link
Contributor

tinvaan commented Feb 21, 2024

Markdown files in the repo do not seem to follow linting guidelines (pre-commit-config.yml actually excludes *.md files) and this is how it looks on my VSCode editor.

Screenshot 2024-02-21 at 11 10 35 AM

Since the project is hosted on Github, it would make sense to follow the Github flavoured markdown syntax for markdown files.

This is a low hanging fruit & a fix can be automated by using a tool like https://mdformat.rtfd.io/

#695 is an attempt to address this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant