Specify Markdown Style

[meichthys]

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]

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]

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

[mattrob33]

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]

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

[StaelTchinda]

I tried to implement it using markdownlint-cli2-action. My approach is on my forked project.

However, it does not work. I tried to set the contribution rules as custom rules using JavaScript (see code, but it seems like code dependencies cannot be added dynamically to Github Actions(see issue).

Any suggestion on what to do and how ?