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

オープン 初心者向け
  • 何か問題がありますか？
#3,334 コメント 2 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
2/5
見積もり時間
半日
初心者へのやさしさ
72/100
issue の種類
ドキュメント
明瞭さ
おおむね明確
活発さ
静か
技術スタック
html
領域
accessibility, documentation

調査の方向性

まず、既存のドキュメント構成と提案に記載されているアクセシビリティの動作を確認します。カスタマイズに関する補足注記については issue #3335 を確認し、その後、記載された機能を網羅し、その注記へのリンクを含む Accessibility ページを追加します。ページを見つけられ、約束された各動作が文書化されていれば完了です。

索引モデルが issue の本文から書いたものです。

説明

proposal stale
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 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.

主要言語
HTML
スター
9.8k
フォーク
2.9k
30日以内にマージされた PR はありません

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

HugoBlox/kit のほかの issue

HugoBlox/kit の issue をすべて見る

似ている issue

Accessibility の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。