Feature Request: format check for README.md

[muescha]

Summary

There should be a check also for README.md files.

Basic example

there are some errors in some readme files.

Motivation

To find errors in README.md

[blainekasten]

@muescha What sort of errors exist and what sort of check do you suggest implementing?

[muescha]

i see for example the 2 linked issues (wrong code in a code block)
or other formatting problems which also would be marked in a docs linting

[github-actions]

Hiya!

This issue has gone quiet. Spooky quiet. 👻

We get a lot of issues, so we currently close issues after 30 days of inactivity. It’s been at least 20 days since the last update here.
If we missed this issue or if you want to keep it open, please reply here. You can also add the label "not stale" to keep this issue open!
As a friendly reminder: the best way to see this issue, or any other, fixed is to open a Pull Request. Check out gatsby.dev/contribute for more information about opening PRs, triaging issues, and contributing!

Thanks for being a part of the Gatsby community! 💪💜

[github-actions]

Hiya!

This issue has gone quiet. Spooky quiet. 👻

We get a lot of issues, so we currently close issues after 30 days of inactivity. It’s been at least 20 days since the last update here.
If we missed this issue or if you want to keep it open, please reply here. You can also add the label "not stale" to keep this issue open!
As a friendly reminder: the best way to see this issue, or any other, fixed is to open a Pull Request. Check out gatsby.dev/contribute for more information about opening PRs, triaging issues, and contributing!

Thanks for being a part of the Gatsby community! 💪💜

[muescha]

@blainekasten the same remark linting like for /docs/ documents...

[blainekasten]

@muescha makes sense to me! Would you be interested in submitting a PR for a linter like this?

[muescha]

Yes. I have worked on this already as a PoC

[meganesu]

@muescha Thanks for making those changes!