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

Specify Markdown Style #2

Open
meichthys opened this issue Feb 12, 2022 · 4 comments
Open

Specify Markdown Style #2

meichthys opened this issue Feb 12, 2022 · 4 comments

Comments

@meichthys
Copy link
Contributor

Since we are using markdown in the main readme, perhaps we should specify the markdown format/linter we want to use/recommend in order to enforce consistency? I think VSCode uses markdownlint by default.

@mattrob33
Copy link
Owner

Good idea. This would be a great use case for using a Github Action to automatically run a linter like markdownlint on all PRs. I'll add a help wanted label if you or someone else want to look into this before I get a chance to do so.

@meichthys
Copy link
Contributor Author

Oo i like the github action idea. I forgot that actions are now free for public repo!

@mattrob33
Copy link
Owner

Yeah they're pretty sweet. I've set up a few on different projects and could help give some guidance and answers questions, but I haven't done Markdown linting (or actually any linting) with them before, so the specifics would take some research time that I don't have at the moment.

@NonlinearFruit
Copy link

If the goal is to be similar to an awesome list, they have a simple linter (source)

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

No branches or pull requests

3 participants