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

Add an optional aria-label to the nav element for screen readers #51

Open
MarcoZehe opened this issue Jan 16, 2021 · 2 comments
Open

Add an optional aria-label to the nav element for screen readers #51

MarcoZehe opened this issue Jan 16, 2021 · 2 comments

Comments

@MarcoZehe
Copy link

When including a TOC on a page, it can happen that this is not the only nav container on a page, with the main navigation possibly being at least one other. it would be good if the plugin would include a default name for the nav element, set via aria-label, and add an option to override this. So the nav would be:

nav aria-label="Table of contents" ...
...
</nav>

or the user provided alternative if they set it.

I am using Markdown-It-TOC-Done-Right in a new Eleventy project and found it the best TOC solution, with only this little bit missing.

Thank you for considering accessibility as one of the reasons why Markdown-It-TOC-Done-Right is the better choice over others! ❤️

MarcoZehe added a commit to MarcoZehe/markdown-it-toc-done-right that referenced this issue Jan 17, 2021
…Fixes Add an optional aria-label to the nav element for screen readers nagaozen#51.
@Antonio-Laguna
Copy link

I love this plugin and the philosophy but this feels abandoned, need help @nagaozen ?

@nagaozen
Copy link
Owner

Sure, more arms are welcome

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

3 participants