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

Emojis not rendering in .mdx or .md files #1028

Open
st3phhays opened this issue Jul 1, 2024 · 8 comments
Open

Emojis not rendering in .mdx or .md files #1028

st3phhays opened this issue Jul 1, 2024 · 8 comments
Assignees
Labels
0 - Backlog Issue is accepted, but is not ready to be worked on or not in current sprint Bug Issues where something has happened which was not expected or intended

Comments

@st3phhays
Copy link
Member

What You Are Seeing?

In .mdx or .md files, emojis are not rendering when using the shorthand syntax, like :floppy_disk:.

What is Expected?

These emojis should be rendered to the emoji and not plain text.

How Did You Get This To Happen? (Steps to Reproduce)

  1. Go to https://docs.chocolatey.org/en-us/central-management/usage/website/groups/
  2. Search for :floppy_disk: on the page. This should be an emoji, not text.
@st3phhays st3phhays self-assigned this Jul 1, 2024
@st3phhays st3phhays added Bug Issues where something has happened which was not expected or intended 0 - Backlog Issue is accepted, but is not ready to be worked on or not in current sprint labels Jul 1, 2024
@st3phhays
Copy link
Member Author

After some discussion, it has been decided that instead of fixing the issue above, we will either:

  1. Remove the emoji entirely or
  2. Replace the emoji with an accessible form of a Font Awesome icon.
  3. Update the README or design system stating the we will not be using emojis going forward.

A lot of times, emojis are not even needed, and they can become inaccessible to screen readers or interpreted differently to different users.

Some reading about emojis and accessibility:

@LeaDevelop
Copy link
Contributor

You could use unicode emojis as well 💾. I volunteer to take care of this issue in case you don't have one yet :)

@LeaDevelop
Copy link
Contributor

LeaDevelop commented Sep 26, 2024

I'm on it, feel free to assign issue to me.
Went with unicode emojis, but can replace it with font awesome as well, just send me expected design for :gear:, :floppy_disk:, :mag:, :heavy_plus_sign:, :calendar, :wastebasket:

LeaDevelop added a commit to LeaDevelop/ChocolateyDocs that referenced this issue Sep 26, 2024
- replace ⚙️ with unicode gear ⚙ emoticon
- replace 💾 with unicode floppy disk 💾 emoticon
LeaDevelop added a commit to LeaDevelop/ChocolateyDocs that referenced this issue Sep 26, 2024
- replace ⚙️ with unicode gear ⚙ emoticon
- replace 💾 with unicode floppy disk 💾 emoticon
- replace 🔍 with unicode magnifying glass tilted left 🔍 emoticon
LeaDevelop added a commit to LeaDevelop/ChocolateyDocs that referenced this issue Sep 26, 2024
- replace ⚙️ with unicode gear ⚙ emoticon
- replace 💾 with unicode floppy disk 💾 emoticon
LeaDevelop added a commit to LeaDevelop/ChocolateyDocs that referenced this issue Sep 26, 2024
- replace 💾 with unicode floppy disk 💾 emoticon
- replace ➕ with unicode plus sign ➕ emoticon
- replace 📆 with unicode calendar 📅 emoticon
LeaDevelop added a commit to LeaDevelop/ChocolateyDocs that referenced this issue Sep 26, 2024
- replace ➕ with unicode plus sign ➕ emoticon
- replace 🗑️ with unicode wastebasket 🗑 emoticon
LeaDevelop added a commit to LeaDevelop/ChocolateyDocs that referenced this issue Sep 26, 2024
- replace ⚙️ with unicode gear ⚙ emoticon
LeaDevelop added a commit to LeaDevelop/ChocolateyDocs that referenced this issue Sep 26, 2024
- replace ⚙️ with unicode gear ⚙ emoticon
LeaDevelop added a commit to LeaDevelop/ChocolateyDocs that referenced this issue Sep 26, 2024
- replace ⚙️ with unicode gear ⚙ emoticon
LeaDevelop added a commit to LeaDevelop/ChocolateyDocs that referenced this issue Sep 26, 2024
- replace ⚙️ with unicode gear ⚙ emoticon
LeaDevelop added a commit to LeaDevelop/ChocolateyDocs that referenced this issue Sep 26, 2024
- replace 🔍 with unicode magnifying glass tilted left 🔍 emoticon
@LeaDevelop
Copy link
Contributor

Submit of PR is WIP, will test changes over the weekend & double check if I missed anything.

LeaDevelop added a commit to LeaDevelop/ChocolateyDocs that referenced this issue Sep 28, 2024
st3phhays added a commit that referenced this issue Oct 1, 2024
@st3phhays
Copy link
Member Author

See comment #1072 (review)

@LeaDevelop
Copy link
Contributor

Do you have specific font awesome design in mind already that should be taken from free or pro license?
I can prepare a draft upon which you can then build further if that's to your liking.

LeaDevelop added a commit to LeaDevelop/ChocolateyDocs that referenced this issue Oct 6, 2024
@LeaDevelop
Copy link
Contributor

Had a further look, font awesome is already present in the yarn.lock so we can go forth and simply insert icons into pages. I got that in progress currently, will finish it up in coming days.

Notes for future documentation writing, I simply followed official font awesome documentation it has it all nicely explained - https://docs.fontawesome.com/web/dig-deeper/accessibility. When writing documentation one simply needs to know if the icon has decorative meaning or semantic. In cases of decorative we set aria-hidden flag to true aria-hidden="true" and the screen reader will not read the icon for example, <i class="fa-regular fa-floppy-disk" aria-hidden="true"></i>

LeaDevelop added a commit to LeaDevelop/ChocolateyDocs that referenced this issue Oct 6, 2024
LeaDevelop added a commit to LeaDevelop/ChocolateyDocs that referenced this issue Oct 6, 2024
LeaDevelop added a commit to LeaDevelop/ChocolateyDocs that referenced this issue Oct 6, 2024
LeaDevelop added a commit to LeaDevelop/ChocolateyDocs that referenced this issue Oct 6, 2024
LeaDevelop added a commit to LeaDevelop/ChocolateyDocs that referenced this issue Oct 6, 2024
LeaDevelop added a commit to LeaDevelop/ChocolateyDocs that referenced this issue Oct 6, 2024
LeaDevelop added a commit to LeaDevelop/ChocolateyDocs that referenced this issue Oct 6, 2024
LeaDevelop added a commit to LeaDevelop/ChocolateyDocs that referenced this issue Oct 6, 2024
LeaDevelop added a commit to LeaDevelop/ChocolateyDocs that referenced this issue Oct 6, 2024
LeaDevelop added a commit to LeaDevelop/ChocolateyDocs that referenced this issue Oct 6, 2024
LeaDevelop added a commit to LeaDevelop/ChocolateyDocs that referenced this issue Oct 6, 2024
LeaDevelop added a commit to LeaDevelop/ChocolateyDocs that referenced this issue Oct 6, 2024
LeaDevelop added a commit to LeaDevelop/ChocolateyDocs that referenced this issue Oct 6, 2024
LeaDevelop added a commit to LeaDevelop/ChocolateyDocs that referenced this issue Oct 6, 2024
@LeaDevelop
Copy link
Contributor

@st3phhays ready for review, we can build further but the base has now been replaced with font awesome and considering screen readers #1076 so if there is icon and the description of it, it won't duplicate it but it'll only read text and skip icon.

LeaDevelop added a commit to LeaDevelop/ChocolateyDocs that referenced this issue Oct 28, 2024
LeaDevelop added a commit to LeaDevelop/ChocolateyDocs that referenced this issue Oct 28, 2024
…ipt for cases when chocolatey is not installed
LeaDevelop added a commit to LeaDevelop/ChocolateyDocs that referenced this issue Dec 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
0 - Backlog Issue is accepted, but is not ready to be worked on or not in current sprint Bug Issues where something has happened which was not expected or intended
Projects
None yet
Development

No branches or pull requests

2 participants