Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Enhance Documentation on Theme-Specific Image Display with Illustration and <img> Tag Clarification #34694

Closed
@syed-ateeb-naveed

Description

@syed-ateeb-naveed

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

image

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:

  1. Add an Illustration: Include images to demonstrate how the sun appears in light mode and the moon in dark mode.
  2. Clarify the <img> Tag: Explain the purpose of the <img> tag as a fallback for browsers that don’t support the prefers-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

Metadata

Metadata

Assignees

No one assigned

    Labels

    contentThis issue or pull request belongs to the Docs Content teamget startedContent related to "Getting Started" doc set

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions