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

feat: add support for emphasis marks in rich text rendering fixes 587 #586

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

etiennejcharles
Copy link

Pull Request: Introduce Separate <em> Tags

Overview

This PR introduces the use of separate <em> tags in our codebase to improve semantic HTML usage and accessibility. Existing <i> tags remain unchanged.

Background

In our current codebase, there is an overuse of <i> tags for both emphasis and stylistic purposes. However, these tags serve different purposes:

  • <em> is used to denote text that is emphasized, conveying importance or stress.
  • <i> is typically used for text that is set off from the normal text, often for stylistic purposes, such as foreign words, technical terms, or names of ships.

Introducing <em> tags for emphasis enhances the semantic meaning of our HTML and improves accessibility for users relying on screen readers.

Changes Introduced

  1. Added <em> Tags:

    • Introduced <em> tags where text needs to be emphasized, replacing the misuse of <i> tags for this purpose.
    • Kept existing <i> tags for stylistic purposes as they are.
  2. Updated CSS Styles:

    • Ensured that styles previously applied to <i> for emphasis are now correctly applied to <em> to maintain visual consistency.
  3. Accessibility Improvements:

    • Improved semantic HTML structure, aiding screen readers and other assistive technologies in providing a better user experience.

@etiennejcharles etiennejcharles changed the title feat: add support for emphasis marks in rich text rendering feat: add support for emphasis marks in rich text rendering fixes 587 Jun 23, 2024
@etiennejcharles
Copy link
Author

etiennejcharles commented Jun 23, 2024

Fixes #587

@chrishelgert
Copy link
Contributor

Hey 👋
Thanks for your contribution. More changes to our internal code are needed before this can be merged.
We will check internally if that's something we can support

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants