Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Please add an option for accessible footnotes #89

Closed
borisschapira opened this issue Dec 3, 2018 · 3 comments
Closed

Please add an option for accessible footnotes #89

borisschapira opened this issue Dec 3, 2018 · 3 comments

Comments

@borisschapira
Copy link

In the html_renderer.rb, please add an aria-label attribute to the footnote "↩" backlink with a default "Back to content" value.
In a second time, allow this value to be modified by a configuration so that developers at the end of the chain could configure a localized value depending on the content locale.

@gjtorikian
Copy link
Owner

Hi there, thank you for opening an issue. Since this would be an addition to the formal Commonmark spec, I suggest opening it over where the development of that spec occurs: https://github.com/github/cmark-gfm

The intent of this repository is to just prove a single Ruby wrapper for the existing C code. It does not add any features that do not already exist in github/cmark-gfm.

Alternative, you are free to create your own custom renderer as a plugin/add-on: https://github.com/gjtorikian/commonmarker#creating-a-custom-renderer. For example, you can see how commonmarker-rouge added syntac highlighting to code blocks on top of this gem.

@gjtorikian
Copy link
Owner

gjtorikian commented Dec 3, 2018

Ah, my apologies, I did a quick re-read and the autoreply there isn't entirely accurate. The aria-label generation issue would still need to be opened at https://github.com/github/cmark-gfm (but this isn't technically a new addition to the spec, I don't think?).

@borisschapira
Copy link
Author

borisschapira commented Dec 4, 2018

Sorry to have bothered you. I saw that the code came from a renderer defined in this project, so I opened an issue here. The Custom Renderer may be a solution, I'll propose it to jekyll-commonmark. As I don't see any renderer in cmark-gfm, I wonder how it could be handled there.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants