Change main navigation to an ARIA Navigation landmark

Open Beginner friendly
#1,785 0 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
90/100
Issue type
Feature
Clarity
Clearly specified
Activity status
Stale
Tech stack
html
Domain
accessibility

Research direction

Start in src/_includes/components/docs-toc.njk at the referenced line and inspect the surrounding skip-navigation markup and the existing Breadcrumbs landmark. Change the skip-nav wrapper to the requested navigation element, then verify that the generated pages retain the same navigation content and include the expected ARIA landmark.

Written by the indexing model from the issue text.

Description

https://github.com/11ty/11ty-website/blob/8fc59f6c7453e45dae0d7460b3dbacd1e6e1f5c4/src/_includes/components/docs-toc.njk#L25

ARIA landmarks can make it easier for screen reader users to navigate to major parts of a page. Currently the only navigation landmark on pages is the Breadcrumbs.

Change <div id="skip-nav"> to <nav id="skip-nav">

You could give it a name, like how the Breadcrumbs landmark is named, but I think an unnamed Navigation landmark will be (correctly) assumed to be the main nav when "Breadcrumbs" is the only other nav landmark.

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

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.

More from 11ty/docs

All issues in 11ty/docs

Similar issues

More Accessibility issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.