-
Notifications
You must be signed in to change notification settings - Fork 182
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
Comments
After some discussion, it has been decided that instead of fixing the issue above, we will either:
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: |
You could use unicode emojis as well 💾. I volunteer to take care of this issue in case you don't have one yet :) |
I'm on it, feel free to assign issue to me. |
- replace ⚙️ with unicode gear ⚙ emoticon - replace 💾 with unicode floppy disk 💾 emoticon
- replace ⚙️ with unicode gear ⚙ emoticon - replace 💾 with unicode floppy disk 💾 emoticon - replace 🔍 with unicode magnifying glass tilted left 🔍 emoticon
- replace ⚙️ with unicode gear ⚙ emoticon - replace 💾 with unicode floppy disk 💾 emoticon
- replace 💾 with unicode floppy disk 💾 emoticon - replace ➕ with unicode plus sign ➕ emoticon - replace 📆 with unicode calendar 📅 emoticon
- replace ➕ with unicode plus sign ➕ emoticon - replace 🗑️ with unicode wastebasket 🗑 emoticon
- replace ⚙️ with unicode gear ⚙ emoticon
- replace ⚙️ with unicode gear ⚙ emoticon
- replace ⚙️ with unicode gear ⚙ emoticon
- replace ⚙️ with unicode gear ⚙ emoticon
- replace 🔍 with unicode magnifying glass tilted left 🔍 emoticon
Submit of PR is WIP, will test changes over the weekend & double check if I missed anything. |
See comment #1072 (review) |
Do you have specific font awesome design in mind already that should be taken from free or pro license? |
…mind including screen reader consideration - https://docs.fontawesome.com/web/dig-deeper/accessibility
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 |
…ility, disabled for screen reader
…some accessibility
…x-emojis' into (chocolatey#1028)-docs-update-fix-emojis
@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. |
…ipt for cases when chocolatey is not installed
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)
:floppy_disk:
on the page. This should be an emoji, not text.The text was updated successfully, but these errors were encountered: