sphinx-book-theme icon indicating copy to clipboard operation
sphinx-book-theme copied to clipboard

Published 20 hours ago • verified publisher icon executablebooks

Add skip to main content link

Open andesol opened this issue 3 years ago • 3 comments

Add a simple jump to main content link on top of the page (only visible when you first press tab) so users can skip the left navigation

image

andesol avatar Sep 28 '22 15:09 andesol

Thanks for submitting your first pull request! You are awesome! :hugs:
If you haven't done so already, check out EBP's Code of Conduct and our Contributing Guide, as this will greatly help the review process.
Welcome to the EBP community! :tada:

welcome[bot] avatar Sep 28 '22 15:09 welcome[bot]

Could you provide some more information about what you mean by "skip the left navigation"? That should all be hidden by default. Is this for screen readers and accessibility purposes?

choldgraf avatar Sep 29 '22 22:09 choldgraf

It's this @choldgraf https://youtu.be/VUR0I5mqq7I

chrisjsewell avatar Sep 29 '22 22:09 chrisjsewell

So this one has actually now been implemented in the upstream theme (pydata-sphinx-theme):

  • https://github.com/pydata/pydata-sphinx-theme/issues/966

I think that we can close this PR since we'll inherit this feature from the upstream, though we should double-check that it is in-fact inherited

many thanks @andesol for surfacing this issue and providing an implementation - I think that the person in the pydata theme used it for inspiration there

choldgraf avatar Oct 25 '22 14:10 choldgraf

I'm gonna close this one as we now have an implementation we'll inherit from the pydata theme!

Here's the PR where this was merged upstream:

  • https://github.com/pydata/pydata-sphinx-theme/issues/966

And here's the PR that should bring this in, assuming that a PyData theme release is made before it is merged:

  • #640

choldgraf avatar Nov 09 '22 10:11 choldgraf