Refine initial markdown CI workflow - Githubissues

UKHO / docs

Documentation around digital development project, teams, behaviors and processes at the UKHO

MIT License

20 stars 11 forks source link

Refine initial markdown CI workflow #119

Closed benbhall closed 4 years ago

benbhall commented 4 years ago

See #115

Relaxed markdown linting rules

This repository is quite mature and gone unchecked; the number of warnings is a little overwhelming.

Reduced Alex.js inclusive language sensitivity to a minimum starting point

Checks for gendered wording off
Lowest sensitivity level for profanity (doesn't highlight 'UK' now)
Set it to allow everything and deny the following rules (not words):

"deny": [
      "blacklist", 
      "blacklisted", 
      "blacklisting", 
      "whitelist",
      "whitelisting",
      "whitelisted",
      "whitespace",
      "sanity-check",
      "dummy"
    ]

Alex.js sits on top of retext-equality, amongst other things. It's very easy to contribute new rules. I added dummy just today: https://github.com/retextjs/retext-equality/pull/103

benbhall commented 4 years ago

Anyone fancy opening an issue to get the new markdown checks to run against diffs only? I'm happy to do it but won't be until November now probably.