Skip to content

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

Description

@Vidminas

Prerequisites

  • I have searched for duplicate or closed feature requests
  • I am mindful of the project 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 Feature request (docs): note accessibility caveats in the customisation / theming guide #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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions