chocolatey / docs

https://docs.chocolatey.org - new docs website
Apache License 2.0
156 stars 176 forks source link

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

Open st3phhays opened 3 months ago

st3phhays commented 3 months ago

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 commented 3 months ago

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 commented 1 week ago

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

LeaDevelop commented 1 week ago

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 commented 1 week ago

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

st3phhays commented 3 days ago

See comment https://github.com/chocolatey/docs/pull/1072#pullrequestreview-2339683843

LeaDevelop commented 3 days ago

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.