cabforum / build-guidelines-action

Action to build Pandoc-flavored Guidelines into their final form
0 stars 3 forks source link

Add a Markdown linter #18

Open sleevi opened 3 years ago

sleevi commented 3 years ago

Tools like markdownlint can help ensure consistency in the Markdown, which is especially important as each Chartered Working Group is free to produce their own documents however they want, and it's up to the Chairs to ensure consistency and formatting.

While there was discussion of a "Markdown style guide" in the past (now tracked at https://github.com/cabforum/forum/issues/11 ), style guides benefit most from automated enforcement/checking (and, ideally, automated formatting).

hablutzel1 commented 4 months ago

https://github.com/cabforum/build-guidelines-action/pull/51 fixes this.