Document that alt text is required for images
Open
Nobody has claimed this yet.
- Dominant language
- Nunjucks
- Stars
- 547
- Forks
- 726
- Avg merge
- 2h 23m
- Merged PRs (30d)
- 3
Description
I think it should be documented more clearly that alt text is required for images, otherwise they will not render. If an image is added without alt text it just doesn't render with a 404 error, which is kind of confusing.
Specifically
- https://www.11ty.dev/docs/plugins/image/#html-transform.
Eleventy will transform any <img> or <picture> tags in HTML filesis a false statement, alt text is required - The examples in https://www.11ty.dev/docs/plugins/image/#resolving-image-sources are lacking alt text.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the HTML Transform and Resolving Image Sources sections at the linked documentation URL. Clarify that images require alt text and update the examples to include it; the documentation is done when the requirement and examples are no longer misleading.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- html
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 50/100