[L2Ork-dev] side-quest: enforce 80-character line-width on README.md

Rukshan J. Senanayaka rjsenanayaka at gmail.com
Sat Apr 10 15:15:22 EDT 2021


I'm still learning this. Maybe we can integrate
https://github.com/markdownlint/markdownlint into the CI/CD flow?

On Sat, Apr 10, 2021 at 11:50 PM Jonathan Wilkes <jon.w.wilkes at gmail.com>
wrote:

> Hi list,
>
> Can someone figure out for me how to make an automated markdown linter
> in Gitlab that enforces an 80-character line-width rule for README.md
> (and all other *.md for that matter)?
>
> I just pushed changes to the README.md that get it back to the
> 80-character line-width requirement that I want to enforce.
>
> People make changes to that README.md with long paragraphs, as if they
> are writing an email like this one and just letting the editor auto
> wrap the lines.
>
> The problem with that is when someone makes a simple diff-- like
> changing "foobar" to "foo-bar", the diff will show the *entire*
> paragraph. Then I must fish around to figure out what exactly the
> change was in that sea of text.
>
> Anyway, I want Gitlab to bark at people when they exceed that limit.
>
> Best,
> Jonathan
> _______________________________________________
> L2Ork-dev mailing list
> L2Ork-dev at disis.music.vt.edu
> https://disis.music.vt.edu/listinfo/l2ork-dev
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://disis.music.vt.edu/pipermail/l2ork-dev/attachments/20210411/a827cac7/attachment.html>


More information about the L2Ork-dev mailing list