search

gettalong / kramdown

kramdown is a fast, pure Ruby Markdown superset converter, using a strict syntax definition and supporting several common extensions.
http://kramdown.gettalong.org
Other
1.72k stars 274 forks source link

RFC: Option to make footnotes and footnote backlinks accessible #692

Closed stevenjmesser closed 1 year ago

stevenjmesser commented 4 years ago

Documents published on GOV.UK are authored in Markdown, and it was recently discovered that footnotes and footnote backlinks are not handled well by screen readers used by user with accessible needs.

To fix this, the Accessibility team on GOV.UK changed the way footnotes are handled. There's more details in these pull requests: https://github.com/alphagov/govspeak/pull/192 and https://github.com/alphagov/govspeak/pull/198

I'm raising this issue to see how others feel about adopting a similar change into Kramdown (or making it optional) in order to make thousands of blogs and websites more accessible to people using screen readers.

Thanks in advance for your comments!

stevenjmesser commented 4 years ago

I've raised https://github.com/gettalong/kramdown/pull/693.

gettalong commented 4 years ago

Thanks for the issue and the pull request!

I get what you want to accomplish with the issue and pull request. If the resulting HTML still validates, it would be okay for me.

However, I can't accept the current implementation since it is language dependent, i.e. the contents of the label are in English which is not suitable in a general case. If there is a language agnostic solution, I will have a more in-depth look at everything.

BryceStevenWilley commented 2 years ago

I would also love something like this, have been trying to make my blog more accessible. I'm not sure there's a good language agnostic solution however, as the main issue is the fact that numbers and backlinks don't have enough information for context.

The linked issues are specifically changing the footnote link text, not adding an aria-label. IMO that's a better accessibility fix, as it also helps sighted users. The ability to do this exists in kramdown now: I was able to change the back links to match the linked issue by using the footnote_backlink option (added this to my jekyll _config.yml:

kramdown:
  footnote_backlink: "[go to where this is referenced]"

However, there's not an equivalent option for changing the link text. footnote_prefix seems like it should, but it only adds to the id of the elements. I might try to extend #693 to add another option, footnote_link_text, to be text that's added in front of the number in the footnote (maybe an sprint-able string, so you could do things like [footnote 1]), and open a PR soon.

stevenjmesser commented 1 year ago

Seemingly addressed in https://github.com/gettalong/kramdown/pull/773