Project

emoji-js

0.0
No commit activity in last 3 years
No release in over 3 years
Emojify your website like GitHub and Campfire! :thumbsup:
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

>= 0

Runtime

 Project Readme

Emoji.JS 🎉

Ever wanted to be able to write :thumbsup: and have 👍 display on your blog? Me to. Let's make this happen...

Getting Started

  1. Get the gem: gem install emoji-js
  2. Go to your project: cd my-project
  3. Generate the files: emoji-js

Project path: (default: current directory)
Emoji graphics path: (default: "graphics/") [enter]
Your project's JavaScript directory: (default: "js/") [enter]
Emoji.JS successfully added to your project.
Now add: '<script src="/js/emoji.min.js"></script>' to the END of your HTML file.

  1. Append <script src="/js/emoji.min.js"></script> to the END of any HTML files that you want this added to.
  2. You're done! 🎉

Why do I have to call this script at the end?

In order to understand this question, one must first understand how Emoji.JS works. Emoji.JS works by scanning the existing webpage for emoji names wrapped in colons (e.g. :dog:), then replaces them with the corrosponding emoji image. This allows for two things. First, it allows for easy emoji integration. Second, it allows for cross-platform use of emoji. Because of this, if the script is not called at the end of the document, there will be nothing to scan. Thus, it is imperitive that you call the script at the end of <body>

... more docs to come!