feat: ensure every rendered <img> has an alt attribute (a11y) - #10
Merged
Conversation
Images reach the HTML two ways: Markdown images (the renderer already emits an alt, even an empty one) and manual raw <img> tags, which frequently lack alt. A missing alt makes screen readers announce the file name. Add ensureImageAlt() and apply it LATE - as the final step in compileMarkdown() on the fully transformed HTML - so both image sources are covered uniformly. Images that already carry an alt (including alt="") are left untouched. Adds unit tests for ensureImageAlt plus parser integration tests proving a raw <img> without alt gets alt="" while an existing alt is preserved.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem
Images reach the generated HTML two ways:
— theimageRendereralways emits analt(even an empty one).<img>tags — authored directly in the Markdown, these frequently have noaltand only pass throughtransformRelativeImagePaths(which rewritessrconly).A missing
altmakes screen readers announce the image's file name — an accessibility gap on any post that hand-writes an<img>.Fix
Add
ensureImageAlt()inshared/html.utils.tsand apply it late — as the final step incompileMarkdown()on the fully transformed HTML — so both image sources are covered uniformly:<img>without anyalt→ gets a decorativealt="".<img>that already has analt(includingalt="") → left untouched.Applying it late (rather than in the image renderer) is deliberate: the renderer only sees Markdown images, while raw
<img>bypass it. Running once on the final HTML catches every image regardless of how it was written.