Feature request (docs): add an "Accessibility" page documenting HugoBlox's built-in a11y features

#3334 · open · 2 comments

View on GitHub ↗

Vidminas

### Prerequisites - [x] I have [searched](https://github.com/HugoBlox/kit/issues?q=is%3Aissue) for duplicate or closed feature requests - [x] I am mindful of the project [scope](https://github.com/HugoBlox/kit/blob/main/CONTRIBUTING.md#scope) ### Proposal Add an **Accessibility** page to the docs (e.g. under *Reference* or *Guide*) describing the a11y features that are (or should be) built into every HugoBlox page, so site owners know what they get out of the box and reviewers/institutions can point to it. Suggested outline: - **Skip to content** — every page renders a "Skip to main content" link as the first focusable element (visually hidden until focused) that jumps to the main landmark. - **Landmarks** — page content is wrapped in `<main id="main-content">`; header/footer are distinct regions. - **Keyboard focus** — interactive controls show a visible `:focus-visible` outline (including the action-link buttons on publications/projects). - **Heading structure** — section titles (collection, markdown, portfolio blocks) render as real `<h2>` headings, so the document has a proper outline for screen-reader navigation. - **Descriptive names** — social/profile icon links expose human-readable accessible names rather than raw icon slugs. - A short **"how to keep it accessible when customising"** callout linking to the companion note (see the customisation issue https://github.com/HugoBlox/kit/issues/3335). ### Motivation and context According to the readme, HugoBlox powers 150k+ sites, many of them academic/institutional. In these contexts, accessibility is commonly a hard requirement (WCAG/Section 508/EN 301 549). The theme now implements several WCAG 2.1 AA basics — bypass blocks (2.4.1), visible focus (2.4.7), info & relationships / headings (1.3.1), and name/role/value (4.1.2) — but the docs don't mention accessibility anywhere, so users can't tell what's covered or cite it.

Comments

github-actions[bot]

Hey, thanks for your first issue! 🚀 Your feedback is vital for improving the project for everyone. Feeling empowered? Squashing this bug yourself could be a great first open-source contribution! We're here to help you. Here's our [Contributor Guide](https://github.com/HugoBlox/kit/blob/main/CONTRIBUTING.md). Let's connect on [Discord](https://discord.gg/z8wNYzb) to chat about it. We've got a super helpful community!

github-actions[bot]

This issue is stale because it has not had any recent activity. The resources of the project maintainers are limited, and so we are asking for your help. If this is a **bug** and you can still reproduce this error on the <code>main</code> branch, consider contributing a Pull Request with a fix. If this is a **feature request**, and you feel that it is still relevant and valuable, consider contributing a Pull Request for review. This issue will automatically close soon if no further activity occurs. Thank you for your contributions.