Description
Code of Conduct
- I have read and agree to the GitHub Docs project's Code of Conduct
What article on docs.github.com is affected?
Article Affected
Basic writing and formatting syntax
Section Affected
Specifying the theme an image is shown to
Issue Description
The current section lacks an illustration of the image behaviour based on the theme, and the purpose of the <img>
tag is not clearly defined. These additions would improve understanding and clarity for readers.
Screenshot Of The Section
What part(s) of the article would you like to see updated?
What part(s) of the article would you like to see updated?
The section titled “Specifying the theme an image is shown to” should be updated. Specifically:
- Add an Illustration: Include images to demonstrate how the sun appears in light mode and the moon in dark mode.
- Clarify the
<img>
Tag: Explain the purpose of the<img>
tag as a fallback for browsers that don’t support theprefers-color-scheme
feature.
Why should the docs be changed? What use cases does it support?
These updates will make the documentation clearer and more practical. Visual aids help users quickly understand the concept, and clarifying the <img>
tag’s role will reduce confusion for developers implementing theme-specific images.
What is the expected outcome or behavior?
Users will better understand how to apply theme-specific images with confidence, improving their projects’ appearance across light and dark modes.
Additional information
No response