MathewSachin / Captura

Capture Screen, Audio, Cursor, Mouse Clicks and Keystrokes
https://mathewsachin.github.io/Captura/
MIT License
9.82k stars 1.84k forks source link

Github workflows - Markdown lint tool #537

Open Prome88 opened 4 years ago

Prome88 commented 4 years ago

Github workflows - Markdown lint tool for documentation.

The lint will fail due to few issues in the documentation MD files. Should I also fix those reported issues or wait for v9.0 documentation to do so?

MathewSachin commented 4 years ago

I tried looking around a bit if we can have the lint output viewable without having to see the whole GitHub action logs. It won't be very helpful otherwise. It should use GitHub Actions annotations and show like in this PR: https://github.com/ember-template-lint/ember-template-lint/pull/966

And, do fix the issues for the current files otherwise this will just display all pull-requests as failing to pass tests.

Prome88 commented 4 years ago

Documentation has been updated to reflect the markdown linter. Implementing viewable output is unfortunately beyond my capabilities.

Should I remove the linter from the commit and just push the updated documentation?