search

jeromegn / DocumentUp

Pretty documentation generator for Github projects with proper Readme.
http://documentup.com
882 stars 90 forks source link

Emoticons on documentation #63

Closed cabello closed 9 years ago

cabello commented 11 years ago

It would be nice to translate :octocat: to :octocat: and all other emoji defined in http://www.emoji-cheat-sheet.com/.

We could use: https://github.com/hassankhan/emojify.js

It looks pretty straightforward.

cabello commented 11 years ago

Okay, I was doing some research on how to implement this and it looks like the Javascript option is not a good one, because very few projects have emoticons on documentation and the Javascript needs two assets: javascript and css file to work.

The other option that looks good is to have this on backend and after the markdown transformation apply a regex like :[^\s]+: to replace it by a class name or a base64 of the emoticon file, what do you think?

jeromegn commented 11 years ago

I think they would be nice to have, but I wouldn't consider it unless I was presented with a really good and simple solution.

Want to take a stab at it?

cabello commented 11 years ago

Definitely I started trying yesterday but I would like to hear your opinion before going ahead, imagine if you say: "emoticons are useless sorry" I could help on another issue then.

jeromegn commented 11 years ago

Does Github support them in READMEs? I'd like to stay as close to Github as possible.

cabello commented 11 years ago

Yeap, they support it.

max-mapper commented 11 years ago

+1 emoji support

rstacruz commented 9 years ago

:+1:

jeromegn commented 9 years ago

This is now working.

Thanks for your patience!