hynek / hatch-fancy-pypi-readme

Fancy PyPI READMEs with Hatch
MIT License
154 stars 10 forks source link

Feature request: expand :rocket: and other GitHub text emoticons #49

Open dimaqq opened 4 months ago

dimaqq commented 4 months ago

Quite a few folks (myself, my coworkers, and even pydantic maintainers) tend to use :rocket: and similar text emoticons from GitHub-flavoured markdown in the readme files.

When these files are packed into a fancy readme and pushed to PyPI, the emoticons are not displayed properly.

I think it would be awesome if this tool took care of the inconsistency.

Example:

Screenshot 2024-06-20 at 13 38 30 Screenshot 2024-06-20 at 13 38 47

hynek commented 4 months ago

Yeah I noticed that in Pydantic's PyPI release but since nobody approached me, I didn't tackle it yet since I wasn't sure anybody cares about that at all.

I think there's an official list of GitHub text emoticons somewhere?

dimaqq commented 4 months ago

Not sure, but there are unofficial lists like this one https://gist.github.com/rxaviers/7360908

No clue as to veracity of this specific list

dimaqq commented 4 months ago

Maybe this is better:

https://github.com/ikatyang/emoji-cheat-sheet/blob/master/README.md

hynek commented 3 months ago

ha: https://api.github.com/emojis

that's lots of emojis tho! there has to be some tool that translates them automatically, though?