11ty / 11ty/docs

Skip link for docs (accessibility improvement)

Open
#248 6 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Nunjucks
Stars
547
Forks
726
Avg merge
2h 23m
Merged PRs (30d)
3

Description

Is your feature request related to a problem? Please describe.
Let's suppose you use a keyboard to navigate through Eleventy docs main page. In order to focus some element within main content (such as link) you have to tab through whole navigation on the left. It takes a while, because there are 57 links in the sidebar!

Describe the solution you'd like
Skip link. If you use tab key on the site, you'll be asked to:

  • skip to main content
  • skip to sidebar navigation

Skip link will show up only if tab key used.

Describe alternatives you've considered
I have not considered any alternatives ;)

Additional context
See how Google does it:

skip-link-in-google

@zachleat if you like the idea, I'll be happy to contribute :)

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No file or test is identified in the issue. Start by tracing the docs page's 57-link sidebar and main content with keyboard navigation; done means keyboard users can reveal links to skip to main content or sidebar navigation, and the links appear when tabbing as described.

Written by the indexing model from the issue text.

Assessment

Domain
accessibility, documentation
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.