Add a linter feature similar to tfproviderdocs

[remyleone]

It would be useful to have at generation time a set of warnings when markdown is not properly linted.
Similar to the features provided by: https://github.com/bflad/tfproviderdocs

[github-actions]

I'm going to lock this issue because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues.
If you have found a problem that seems similar to this, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.