Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

#

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Jump to bottom

Add markdown linter and formatter #347

Closed
nifadyev opened this issue Oct 16, 2024 · 1 comment · Fixed by #354
Closed

Add markdown linter and formatter #347

nifadyev opened this issue Oct 16, 2024 · 1 comment · Fixed by #354

Comments

@nifadyev
Copy link
Contributor

Current README.md does not follow any markdown convention formats. The project should choose a markdown flavor and stick to it with the help of linter/formatter
@satwikkansal
Copy link
Owner

We can configure this Github action https://github.com/DavidAnson/markdownlint-cli2-action , and as for the flavor we can go with https://github.github.com/gfm/

Open to other suggestions as well!

@nifadyev nifadyev mentioned this issue Oct 23, 2024
Merged
satwikkansal added a commit that referenced this issue Nov 5, 2024
@satwikkansal
Merge pull request #354 from nifadyev/feature/#347/configure-markdown…
15429d0 
…-linter-and-formatter

#347: Add markdownlint-cli2 as Github Action and pre-commit hook
@nifadyev nifadyev closed this as completed Nov 5, 2024
# for free to join this conversation on GitHub. Already have an account? # to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

#347: Add markdownlint-cli2 as Github Action and pre-commit hook nifadyev/wtfpython
2 participants
@satwikkansal @nifadyev