-
-
Notifications
You must be signed in to change notification settings - Fork 5.7k
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
[Issue #494] New config option skipLink for accessibility #495
Conversation
We might need to add an |
@@ -251,6 +258,15 @@ export function initRender(vm) { | |||
dom.before(navAppendToTarget, navEl) | |||
} | |||
|
|||
if (config.skipLink |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I tried adding this to <body></body>
but <nav>
was always added first
I think this should be a plugin. |
Ok, I'll split it as a plugin |
Yes. |
I think accessibility should be in core, right? Isn't what the site "looks" like important, not just for people with eyes? @jhildenbiddle wdyt? |
@trusktr -- Accessibility should absolutely be a concern for the core team, and we can and should do better moving forward. See #494 (comment) for related feedback. I'm guessing that the above recommendation was made based on the assumption that adding a skip link meant that the link would be visible on all sites and, since many people may not want that, users could "opt-in" by either installing the plugin or not. Again, just a guess. Fortunately, this isn't the case. We can add a "Skip Navigation" link to the top of the sidebar that is hidden by default but becomes visible when it receives focus. Let's work through the problem in #494 and see where we land. I think this is a good feature to add and accessibility features like this should be part of docsify core. That said, I'm not sure this is the sort of thing we should add to v4. A significantly improved a11y experience would also be a pretty big achievement for v5. Note: I've added an accessibility label so we can easily filter the issues list. |
Please makes sure these boxes are checked before submitting your PR, thank you!
master
branch.lib
directory.skipLink
config option + updated docs