https://github.com/rcmdnk/octopress-gemoji

https://github.com/rcmdnk/octopress-gemoji

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/rcmdnk/octopress-gemoji
• Owner: rcmdnk
• License: mit
• Created: 2013-09-27T21:52:06.000Z (about 11 years ago)
• Default Branch: master
• Last Pushed: 2023-12-01T14:30:01.000Z (12 months ago)
• Last Synced: 2024-05-01T12:24:43.716Z (7 months ago)
• Language: Ruby
• Size: 7.81 KB
• Stars: 7
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
octopress-gemoji

================

octopress-gemoji provides "gemoji" tag to use emoji in Octopress.

:memo:

There is a similar plugin, [jekyll-emoji](https://github.com/chriskempson/jekyll-emoji), which provides filter for emoji description (such `:smile:`).

## Installation

1. Copy `plugins/gemoji.rb` to your `plugins` directory,

and `sass/plugins/_gemoji.scss` to your `sass/plugins/` directory.

1. Add a following line to `sass/plugins/_plugins.scss`:

    @import "gemoji";

1. Add a line like `emoji_dir: /images/emoji` to your `_config.yml`

1. Add `gem 'gemoji'` to Gemfile and do `bundle install`.

Done!

:memo: `_egmoji.scss` has settings for `emoji` class which is used by [jekyll-emoji](https://github.com/chriskempson/jekyll-emoji), too.

`emoji_dir` and `gemoji` are also used by [jekyll-emoji](https://github.com/chriskempson/jekyll-emoji).

If you already have these settings for [jekyll-emoji](https://github.com/chriskempson/jekyll-emoji), you don't need to add them.

## Usage

Use tag `gemoji` + `emoji names`:

    {% gemoji smile %}

will be :smile:.

See [EMOJI CHEAT SHEET](http://www.emoji-cheat-sheet.com/) for more emojis.

[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/rcmdnk/octopress-gemoji/trend.png)](https://bitdeli.com/free "Bitdeli Badge")

## Update for gemoji-2.x

From [gemoji](https://github.com/github/gemoji) 2.X,

it changed image directory structures and names.

To update octopress-gemoji for it, you need to:

- Update octopress-gemoji to the latest version.

- Remove **source/images/emoji/** directory from your Octopress.

- Do at least 1 additional `rake generate` before the final `rake generate` for publishing.

(This is needed to copy pictures from gemoji to Octopress images directory.)