Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improved HTML Structure for Better Accessibility and Maintainability #1434

Merged
merged 8 commits into from
Nov 25, 2024

Conversation

eagleanurag
Copy link
Contributor

Commit Description:

Semantic Sectioning and Class Names:
    Updated class names to be more descriptive.
    Ensured better readability and maintainability.

Alt Text for Images:
    Added alt attributes to all <img> tags to improve accessibility.

SVG Elements:
    Added appropriate role attributes to SVG elements.

External Links:
    Updated external links to open in a new tab using target="_blank".
    Added rel="noopener noreferrer" for security reasons.

CSS Separation:
    Inlined styles for demonstration purposes but recommended moving them to a separate stylesheet for better separation of concerns.

If this pull request (PR) pertains to Chinese-to-English translation, please confirm that you have read the contribution guidelines and complete the checklist below:

  • This PR represents the translation of a single, complete document, or contains only bug fixes.
  • The translation accurately conveys the original meaning and intent of the Chinese version. If deviations exist, I have provided explanatory comments to clarify the reasons.

If this pull request (PR) is associated with coding or code transpilation, please attach the relevant console outputs to the PR and complete the following checklist:

  • I have thoroughly reviewed the code, focusing on its formatting, comments, indentation, and file headers.
  • I have confirmed that the code execution outputs are consistent with those produced by the reference code (Python or Java).
  • The code is designed to be compatible on standard operating systems, including Windows, macOS, and Ubuntu.

Commit Description:

    Semantic Sectioning and Class Names:
        Updated class names to be more descriptive.
        Ensured better readability and maintainability.

    Alt Text for Images:
        Added alt attributes to all <img> tags to improve accessibility.

    SVG Elements:
        Added appropriate role attributes to SVG elements.

    External Links:
        Updated external links to open in a new tab using target="_blank".
        Added rel="noopener noreferrer" for security reasons.

    CSS Separation:
        Inlined styles for demonstration purposes but recommended moving them to a separate stylesheet for better separation of concerns.
@CodeDance2023
Copy link

good

@krahets
Copy link
Owner

krahets commented Jul 26, 2024

Thanks for the PR! Could you help update docs/index.html and zh-hant/index.html also?

Copy link
Owner

@krahets krahets left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@krahets krahets added documents documents-related polish Decorative detail or feature labels Nov 25, 2024
@krahets krahets merged commit 01a5f7b into krahets:main Nov 25, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documents documents-related polish Decorative detail or feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants