📝 Documentation: Consider adding emojis to .md section headings

JoshuaKGoldberg / create-typescript-app

Quickstart-friendly TypeScript template with comprehensive, configurable, opinionated tooling. 💝

MIT License

1.2k stars 75 forks source link

📝 Documentation: Consider adding emojis to .md section headings #961

Closed JoshuaKGoldberg closed 1 year ago

JoshuaKGoldberg commented 1 year ago

Bug Report Checklist

[X] I have pulled the latest main branch of the repository.
[X] I have searched for related issues and found none that matched my issue.

Overview

An idea courtsey of @atilafassina (thanks!): https://github.com/atilafassina/apex-monorepo/tree/c5a0798e658cc976fe61e38a73e012ae5afb0c55 has headings with emojis in them. I kind of love that. It breaks up the page visually and is delightful.

## Deploying Apps 🚀

Let's do that here!

Additional Info

Assigning to myself because I can be picky with emojis. 😄

HarshitVashisht11 commented 1 year ago

Can i also work on this

JoshuaKGoldberg commented 1 year ago

No, I'll take this one on. But feel free to look at the other, un-assigned issues!

JoshuaKGoldberg commented 1 year ago

Actually, this ends up being a mild usability issue I think. Heading IDs don't have emojis in them but they do have an extra -: e.g. https://github.com/atilafassina/apex-monorepo/tree/c5a0798e658cc976fe61e38a73e012ae5afb0c55#bots-. So closing for now.

cc @atilafassina in case I'm missing something. 👋

atilafassina commented 1 year ago

Yes, I hadn't realized that before. The emojis do mess up with the anchor by being replaced with a -.

I'm not sure if I'd call it an usability issue as it does make the anchor easier to type (specially if you're in a system with not great emoji support).

But it is a quirk since it isn't widely known that these """"""sanitization"""""" happens 😕

Since my repos aren't so widely used as this or most of yours, I'll keep them for now since it doesn't affect a11y much.