allejo / jekyll-anchor-headings

A GitHub Pages compatible way of adding anchors to your headings without a plug-in or JavaScript :octocat:
https://pure-liquid.allejo.org/
MIT License
186 stars 31 forks source link

Update to Accessibility page in wiki #39

Closed lee0c closed 2 months ago

lee0c commented 2 months ago

Markdown Engine

Kramdown

Snippet Usage

Not usage related but docs related.

Expected HTML Output

n/a

Actual HTML Output

n/a

Additional Comments

The suggestion on your accessibility page to fully remove header permalinks for screen reader users is extremely bad practice and should be removed, especially since you have two other more workable suggestions alongside it.

If you are insistent on providing a method of removing these links, it needs to be more complete and thought-through. As it stands, using aria-hidden and tabindex will remove the element from screen reader (SR) output and prevent focus from landing on it, but change nothing visually. Partially sighted users who rely somewhat but not fully on SR, or any keyboard users, will see an element that has been styled to look focusable/like a link, but can't be reached or explained.

lee0c commented 2 months ago

I am happy to create the edits needed to introduce this change; please just let me know.

allejo commented 2 months ago

Thank you for pointing that out! I hadn't considered that approach, but you're right; another con that I hadn't considered is that there'd be bias toward abled users being able to use permalinks but not all AT users would.

I've removed the last approach from the Wiki; let me know if there's anything else that needs to be changed.