Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Rails gem which adds emoji parsing to markdown
Ruby JavaScript
branch: master

This branch is 19 commits behind elm-city-craftworks:master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
lib
test
vendor/assets/images/emojis
.gitignore
.travis.yml
Gemfile
Gemfile.lock
LICENSE
README.markdown
Rakefile
md_emoji.gemspec

README.markdown

Markdown Emoji for Rails

Want to include emoji in your rails app? Well now you can!

:balloon: :smile: :balloon:

Markdown Emoji was designed to work with the Redcarpet markdown processor and Rails 3.1 with the asset pipeline enabled.

Warning This gem does some scary stuff under the hood, so please check out the code, test first, and don't hesitate to ask questions :)

Build Status

Installation

Add the following line to your Gemfile

gem 'md_emoji'

Using

When creating a new markdown renderer, just use MdEmoji::Render

markdown = Redcarpet::Markdown.new(MdEmoji::Render)

markdown.render("Hello :smile: world!")

Emoji assets will automatically be picked up by the asset pipeline and made available to your app at:

/assets/emojis/<EMOJI_NAME>.png

For a full list of supported emoji, just run MdEmoji::EMOJI in your console.

Contributing

Features and bugs are tracked through Github Issues.

Contributors retain copyright to their work but must agree to release their contributions under the same terms as this project. For details, please see the LICENSE file.

If you would like to help with developing MD Emoji, please get in touch! Contact Jordan through GitHub (@jordanbyron) or Twitter (@jordan_byron)

Submitting a Pull Request

  1. If a ticket doesn't exist for your bug or feature, create one on GitHub.
    • NOTE: Don't be afraid to get feedback on your idea before you begin development work. In fact it is encouraged.
  2. Fork the project.
  3. Create a topic branch.
  4. Implement your feature or bug fix.
  5. Add documentation for your feature or bug fix.
  6. Add tests for your feature or bug fix.
  7. Run rake test. If your changes are not 100% covered, go back to step 6.
  8. If your change affects something in this README, please update it
  9. Commit and push your changes.
  10. Submit a pull request.

Authorship

Emoji images are from emoji-cheat-sheet.com's github project. This project was inspired by GitHub's emoji implementation and hacked together by Jordan Byron.

License

Copyright (c) 2011 Jordan Byron

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.


MD Emoji - a Mendicant University project

Something went wrong with that request. Please try again.