Giter VIP home page Giter VIP logo

jemoji's Introduction

Jemoji

GitHub-flavored Emoji plugin for Jekyll

Gem Version Build Status

Usage

Add the following to your site's Gemfile

gem 'jemoji'

And add the following to your site's _config.yml

plugins:
  - jemoji

πŸ’‘ If you are using a Jekyll version less than 3.5.0, use the gems key instead of plugins.

In any page or post, use emoji as you would normally, e.g.

I give this plugin two :+1:!

Emoji images

For GitHub Pages sites built on GitHub.com, emoji images are served from the GitHub.com CDN, with a base URL of https://github.githubassets.com, which results in emoji image URLs like https://github.githubassets.com/images/icons/emoji/unicode/1f604.png.

On GitHub Enterprise installs, page builds receive the ASSET_HOST_URL environment variable, which contain a value like https://assets.ghe.my-company.com. This results in emoji images for GitHub Pages sites built on a GitHub Enterprise install being served at URLs like https://assets.ghe.my-company.com/images/icons/emoji/unicode/1f604.png.

Customizing

If you'd like to serve emoji images locally, or use a custom emoji source, you can specify so in your _config.yml file:

emoji:
  src: "/assets/images/emoji"

See the Gemoji documentation for generating image files.

jemoji's People

Contributors

ashmaroli avatar benbalter avatar christophersjchow avatar dependabot[bot] avatar dirtyf avatar gjtorikian avatar gregose avatar jdennes avatar jekyllbot avatar morendil avatar naftulikay avatar parkr avatar sahat avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

jemoji's Issues

HTML tag inconsistency

The jemoji plugin is altering tag structure in the rendered HTML.

In my layout Im usiing a <gcse:searchresults-only></gcse:searchresults-only> tag. Whenever in a md file I add a emoji (like πŸ‘…) then it becomes <searchresults-only></searchresults-only>.

If I remove the emoji, then it renders fine.

I also use the seo plugin. Sometimes the seo generated tags end with backslash.
<meta property="og:title" content="Test" />

Sometimes they end without the backslash. I think this is a jemoji issue.

Time for a new release

Hello, maintainers! πŸ‘‹

By my calculations, it's time for a new release of jemoji. It's been over 2 months since the last release, v0.10.0.

What else is left to be done before a new release can be made? Please make sure to update History.markdown too if it's not already updated.

Thanks! πŸ’ž ✨

Dependency Errors

A dependency on an old version of activesupport forces an error with json.

Dependency Error: Yikes! It looks like you don't have jemoji or one of its dependencies installed. In order to use Jekyll as currently configured, you'll need to install this gem. The full error message from Ruby is: 'Unable to activate activesupport-4.2.7.1, because json-2.0.3 conflicts with json (>= 1.7.7, ~> 1.7)' If you run into trouble, you can find helpful resources at https://jekyllrb.com/help/!

I've had this on multiple machines. OSX, Ubuntu/Trusty64, and Windows10

Is `jemoji` accessible to screen readers?

The issue of Emoji accessibility recently came up in our On-Demand courses. From what I understand, the alt-text in Emoji is what screen readers see so, ❀️ would be read as: colon heart colon.

We're making some efforts to improve the accessibility of Emoji in our project, but I thought we'd also check in with you because, if we can find a solution for Jemoji we can have a lot greater impact than in our one project. Some ideas: could the alt-text include more readable content? Or could there be a way for users to specify what the alt-text is for each of their projects?

emoji shouldn't be compiled in code block

I'm trying to show the emoji raw code in GitHub pages like this: :metal:, but jekyll renders it as raw image tag. For example, the result of

:metal:
`:metal:`

is

screen shot 2014-07-30 at 7 06 20 pm

Other places like GitHub issues or wikis works as expected but not GitHub pages.

Emoji not working local (?)

Hi, i have a problem with jemoji; in github pages is working fine but when i try to build locally this happens (_config.dev.yml is a alternative configuration file which only difference is url: http://localhost:4000):

I:\GitHub\testingghp>bundle exec jekyll serve --config _config.dev.yml
Configuration file: _config.dev.yml
Dependency Error: Yikes! It looks like you don't have jemoji or one of its dependencies installed. In order to use Jekyll as currently configured, you'll need to install this gem. The full error message from Ruby is: 'cannot load such file -- jemoji' If you run into trouble, you can find helpful resources at http://jekyllrb.com/help/!
jekyll 3.1.2 | Error: jemoji

However i have jemoji and his dependencies installed:

*** LOCAL GEMS ***

activesupport (4.2.6)
addressable (2.4.0)
bigdecimal (1.2.4)
bundler (1.11.2)
coffee-script (2.4.1)
coffee-script-source (1.10.0)
colorator (0.1)
ethon (0.8.1)
execjs (2.6.0)
faraday (0.9.2)
ffi (1.9.10 x64-mingw32)
gemoji (2.1.0)
github-pages (56)
github-pages-health-check (1.1.0)
html-pipeline (2.3.0)
i18n (0.7.0)
io-console (0.4.3)
jekyll (3.1.2, 3.0.3)
jekyll-coffeescript (1.0.1)
jekyll-feed (0.4.0)
jekyll-gist (1.4.0)
jekyll-mentions (1.1.1)
jekyll-paginate (1.1.0)
jekyll-redirect-from (0.9.1)
jekyll-sass-converter (1.4.0, 1.3.0)
jekyll-seo-tag (1.3.2)
jekyll-sitemap (0.10.0)
jekyll-textile-converter (0.1.0)
jekyll-watch (1.3.1)
jemoji (0.6.1)
json (1.8.3, 1.8.1)
kramdown (1.10.0, 1.9.0)
liquid (3.0.6)
listen (3.0.6)
mercenary (0.3.5)
mini_portile2 (2.0.0)
minitest (5.8.4, 4.7.5)
multipart-post (2.0.0)
net-dns (0.8.0)
nokogiri (1.6.7.2 x64-mingw32)
octokit (4.3.0)
octopress (3.0.11)
octopress-deploy (1.3.0)
octopress-escape-code (2.1.1)
octopress-hooks (2.6.1)
psych (2.0.5)
public_suffix (1.5.3)
rake (10.1.0)
rb-fsevent (0.9.7)
rb-inotify (0.9.7)
rdiscount (2.1.8)
rdoc (4.1.0)
redcarpet (3.3.4, 3.3.3)
RedCloth (4.2.9)
rouge (1.10.1)
safe_yaml (1.0.4)
sass (3.4.21)
sawyer (0.7.0)
terminal-table (1.5.2)
test-unit (2.1.8.0)
thread_safe (0.3.5)
titlecase (0.1.1)
typhoeus (0.8.0)
tzinfo (1.2.2)
wdm (0.1.1)

I try using ruby 2.1.8 which is almost the same as 2.1.7 used in github pages but with a security pacth (i checked), but the problem is the same.

repo: https://github.com/GeekinaCave/testingghp

Hope you can help me.

Integration with amp

Time to reopen amp integration. We have amp-jekyll now which gives amp-img conversion out of the box, but somehow jemoji built img tags are getting bypassed. This needs to get some priority as amp pages are gaining popularity.

jekyll/plugin_manager.rb:29:in `require': cannot load such file -- jemoji (LoadError)

TravisCI is throwing this error when it tries to jekyll build.

/home/travis/.rvm/gems/ruby-2.1.1/gems/jekyll-2.5.3/lib/jekyll/plugin_manager.rb:29:in `require': cannot load such file -- jemoji (LoadError)
    from /home/travis/.rvm/gems/ruby-2.1.1/gems/jekyll-2.5.3/lib/jekyll/plugin_manager.rb:29:in `block in require_gems'
    from /home/travis/.rvm/gems/ruby-2.1.1/gems/jekyll-2.5.3/lib/jekyll/plugin_manager.rb:26:in `each'
    from /home/travis/.rvm/gems/ruby-2.1.1/gems/jekyll-2.5.3/lib/jekyll/plugin_manager.rb:26:in `require_gems'

β€” https://travis-ci.org/dsernst/dsernst.github.io/builds/78518899

You can see on line 245 of that Travis log: Installing jemoji 0.5.0, so not sure where the problem is here.

Any advice on how to get a more clear debug message?

Thanks

the same thing in html?

Hi

I'm not asking for a new feature or whatever, the use-case is pretty limited so I just need some help and clarification.

If I have, say, a index.html file (with YAML front matter and a layout and stuff), how do I go about using emojis in it?
As I understand it, these are GitHub Emojis, so it's intended to use in markup, but how would I use them in html, in a manner that would be test-able locally too?

I don't know if I'm clear, let me know if you have trouble understanding my issue.

Thanks for reading.

Time for a new release

Hello, maintainers! πŸ‘‹

By my calculations, it's time for a new release of jemoji. It's been over 2 months since the last release, v0.9.0.

What else is left to be done before a new release can be made? Please make sure to update History.markdown too if it's not already updated.

Thanks! πŸ’ž ✨

Time for a new release

Hello, maintainers! πŸ‘‹

By my calculations, it's time for a new release of jemoji. It's been over 2 months since the last release, v0.10.0.

What else is left to be done before a new release can be made? Please make sure to update History.markdown too if it's not already updated.

Thanks! πŸ’ž ✨

Unable to use emoji from Unicode Version 7.0+

While many emoji work, πŸ€– , πŸ‡ΉπŸ‡· , πŸ™ƒ , some others don't get rendered. They just show up as their aliases, i.e. :robot:, :tr:, :upside_down_face_:, etc..

The only pattern I can see is that the ones that don't work have been released as part of Unicode version later than 6.1. Help please?

screen shot 2016-11-25 at 1 42 28 pm

Use Jemoji Configuration in plugins array

Hi,

Using the latest Jekyll version 3.8.3. Instead of plugins we still have the gems array in the _config.yml for Jemoji only. This warning is issued.

Deprecation: The 'gems' configuration option has been renamed to 'plugins'. Please update your config file accordingly.

Are there any plans to make it work with the plugins array? Currently, I use both.

An example

plugins:
  - jekyll-archives
  - jekyll-paginate
  - jekyll-sitemap
  - jekyll-feed
  - jekyll-email-protect
  - jekyll-gist  

gems:
  - jemoji

Lock down to activesupport < 5

activesupport 5.0 is giving us tons of problems because versions of Ruby < 2.2.2 aren't supported and they appear not to be able to know that they can't install these updated versions (i.e. if you're running Ruby 2.1.7, it's highest possible value is 4.2.4 or something).

We need to lock this gem down to activesupport 4.2 for now.

/cc jekyll/jekyll-mentions#36

jemoji no longer working for Jekyll 3.0+ releases

Both on our site, as on jekyllrb.com, this seems to be the case:

Our _config.yml has:

gems:
  - jemoji

Our Gemfile has:

gem 'jekyll', '3.0.1'
gem 'jemoji', '0.5.1'

I have also tried with jemoji 0.5.1 and jekyll 3.1.1, no luck.

double `emoji/` in default urls

Hi, it's me again.

I got jemoji "working" in my html files, with:
this in the Gemfile

gem "github-pages", group: :jekyll_plugins

this in _config.yml

gems:
- jemoji

and this in my html file:

<p>
      :warning: Coming soon
</p>

the output created by jekyll and jemoji is this:

<p>
      <img class="emoji" title=":warning:" alt=":warning:" src="https://assets-cdn.github.com/images/icons/emoji/emoji/unicode/26a0.png" height="20" width="20" align="absmiddle"> Coming soon
</p>

Please notice the url. images/icons/emoji/emoji/unicode
Somehow, there's a double insertion of emoji/ here.

Am I doing something wrong somewhere, or is this a bug?

Docs: Encourage the use of the plugins config key

πŸ†•πŸ₯☝ First Timers Only.

This issue is reserved for people who never contributed to Open Source before. We know that the process of creating a pull request is the biggest barrier for new contributors. This issue is for you πŸ’

About First Timers Only.

πŸŽƒπŸ’»πŸ‘• Hacktoberfest: Trick or Treat!

If you haven’t yet, sign up for Hacktoberfest to earn an exclusive T-Shirt. Plus I’m sure we can teach you a cool trick or two in the process

πŸ€” What you will need to know.

Nothing. This issue is meant to welcome you to Open Source :) We are happy to walk you through the process.

πŸ“‹ Step by Step

  • πŸ™‹ Claim this issue: Comment below.

    Once claimed we add you as contributor to this repository.

  • πŸ‘Œ Accept our invitation to this repository. Once accepted, assign yourself to this issue

  • πŸ“ Update the file README.md in the jemoji repository (press the little pen Icon) and edit the line as shown below.

@@ -16,10 +16,12 @@ gem 'jemoji'
 And add the following to your site's `_config.yml`
 
 ```yml
-gems:
+plugins:
   - jemoji

+:bulb: If you are using a Jekyll version less than 3.5.0, use the gems key instead of plugins.
+
In any page or post, use emoji as you would normally, e.g.

  • πŸ’Ύ Commit your changes

  • πŸ”€ Start a Pull Request. There are two ways how you can start a pull request:

  1. If you are familiar with the terminal or would like to learn it, here is a great tutorial on how to send a pull request using the terminal.

  2. You can edit files directly in your browser

  • 🏁 Done Ask in comments for a review :)

πŸ€”β“ Questions

Leave a comment below!

This issue was created by First-Timers-Bot.

Time for a new release

Hello, maintainers! πŸ‘‹

By my calculations, it's time for a new release of jemoji. It's been over 2 months since the last release, v0.8.1.

What else is left to be done before a new release can be made? Please make sure to update History.markdown too if it's not already updated.

Thanks! πŸ’ž ✨

jemoji parsing of included html in markdown files

I have a markdown posts in which I include some raw html files. It seems that jemoji is parsing that html and trying to insert emojis where some property:value pairs are located. This is, not surprisingly, breaking jekyll when I try to serve the site.

Is there a way around this?

Integrating with img-amp / a bit more generalization [feature request]

I'm using AMP HTML on github pages based off of the amplify theme and for the most part everything is awesome πŸŽ‰ but unfortunately I cannot use emoji directly 😒.

The problem is that AMP HTML doesn't want one to use img tags directly but instead wants you to use amp-img tags.

While I'm not expecting amp-img support directly (where would it end 😱), I was wondering if it was possible to make jemoji more configurable by using a layout template.

For example, in the _config.yml a setting could be added like

emoji:
  layout: emoji_include

So then whenever an emoji is used like :tada:, the template _includes/emoji_include.html is used with a variable passed in such as include.emoji_url.

For my amp-img example I could then have the following contents in _includes/emoji_include.html:

<amp-img width="20" height="20" layout="fixed" src="{{ include.emoji_url }}"></amp-img>

And the result of that template is what would be inserted into the page. I imagine some good variables to pass in would probably be the url, alt text, width, and height.

Let me know your thoughts or if I completely missed a way to achieve a similar result as is! πŸ’―

My emoji on github.io cannot display inline

Hey guys, I try to use emoji in my blogs which built on github pages. I add pulgins in my _config.yml as follows:

gems: 
  - jemoji

I want to display emoji inline, but it came out between lines 😭 . Click here to check. How to solve it?

Thanks.

Unable to use jemoji on Github pages

Hello,

I've been trying to use this gem into my GitHub-hosted website, but I'm jekyll returns me this error:

[alecive@malakim]$ jekyll serve
Configuration file: /home/alecive/code/alecive.github.io/_config.yml
  Dependency Error: Yikes! It looks like you don't have jemoji or one of its dependencies installed. In order to use Jekyll as currently configured, you'll need to install this gem. The full error message from Ruby is: 'Unable to activate activesupport-4.2.7, because json-2.0.2 conflicts with json (>= 1.7.7, ~> 1.7)' If you run into trouble, you can find helpful resources at http://jekyllrb.com/help/! 
jekyll 3.2.1 | Error:  jemoji

This is my gem list command:

[alecive@malakim]$ sudo gem list
[sudo] password for alecive: 

*** LOCAL GEMS ***

activesupport (5.0.0.1, 4.2.7)
addressable (2.4.0)
bigdecimal (1.2.7, default: 1.2.6)
coffee-script (2.4.1)
coffee-script-source (1.10.0)
colorator (1.1.0, 0.1)
concurrent-ruby (1.0.2)
ethon (0.9.1)
execjs (2.7.0)
faraday (0.9.2)
ffi (1.9.14)
forwardable-extended (2.6.0)
gemoji (2.1.0)
github-pages (98)
github-pages-health-check (1.2.0)
html-pipeline (2.4.2)
i18n (0.7.0)
io-console (0.4.6, default: 0.4.3)
jekyll (3.2.1, 3.0.3)
jekyll-coffeescript (1.0.1)
jekyll-feed (0.8.0, 0.5.1)
jekyll-gist (1.4.0)
jekyll-github-metadata (2.1.1)
jekyll-mentions (1.2.0)
jekyll-paginate (1.1.0)
jekyll-redirect-from (0.11.0)
jekyll-sass-converter (1.4.0, 1.3.0)
jekyll-seo-tag (2.0.0)
jekyll-sitemap (0.10.0)
jekyll-swiss (0.4.0)
jekyll-textile-converter (0.1.0)
jekyll-watch (1.5.0)
jemoji (0.7.0)
json (2.0.2, default: 1.8.1)
kramdown (1.12.0, 1.11.1)
liquid (3.0.6)
listen (3.1.5, 3.0.6)
mercenary (0.3.6)
mini_portile2 (2.1.0)
minima (2.0.0, 1.2.0)
minitest (5.9.1, 5.8.4)
multipart-post (2.0.0)
net-dns (0.8.0)
nokogiri (1.6.8.1)
octokit (4.3.0)
octopress (3.0.12.pre.1)
octopress-deploy (1.3.0)
octopress-escape-code (2.1.1)
octopress-hooks (2.6.2)
pathutil (0.14.0)
psych (2.1.1, default: 2.0.8)
public_suffix (2.0.3, 1.5.3)
rake (11.3.0, default: 10.4.2)
rb-fsevent (0.9.7)
rb-inotify (0.9.7)
rdiscount (2.2.0.1)
rdoc (4.2.2, default: 4.2.0)
redcarpet (3.3.4)
RedCloth (4.3.2)
rouge (2.0.6, 1.11.1)
ruby_dep (1.5.0)
rubygems-update (2.6.7)
safe_yaml (1.0.4)
sass (3.4.22)
sawyer (0.7.0)
terminal-table (1.7.3)
thread_safe (0.3.5)
titlecase (0.1.1)
typhoeus (1.1.0, 0.8.0)
tzinfo (1.2.2)
unicode-display_width (1.1.1)

I then tried to uninstall json 1.8.1, but also this gives me an error:

[alecive@malakim]$ sudo gem uninstall json --version 1.8.1
ERROR:  While executing gem ... (Gem::InstallError)
    gem "json" cannot be uninstalled because it is a default gem

What should I do?

update from 0.9.0 to 0.10.0 breaks emojis

I updated the gems of my Jamstack website and found out that 0.10.0 is the gem that breaks eventually the emojis.

Actual result:

The website contains :bike:

Expected result:

The website contains 🚲 (as emoji)

Have a look here: https://github.com/rriemann/blog.riemann.cc/commit/7c3efdb4b3d7837855e10a0480296d3653745bba

The next commit reverts the jemoji update to make emojis working again.

Unfortunately, I cannot provide at the moment a minimal not-working example. I use a proprietary gem in my setup.

Edit:

https://5b444c09fdd72a6adce6dbfd--blog-riemann.netlify.com/digitalisation/2018/06/06/open-letter-call-for-a-collaborative-data-protection-faq/

The table in the link above (output of the linked commit) should have plenty country flag emojis.

Time for a new release

Hello, maintainers! πŸ‘‹

By my calculations, it's time for a new release of jemoji. It's been over 2 months since the last release, v0.11.0.

What else is left to be done before a new release can be made? Please make sure to update History.markdown too if it's not already updated.

Thanks! πŸ’ž ✨

Filter?

Love this plug. Nice to see that it's supported by GHPages.

Any way to use this as a liquid filter?

Jemoji images

Hi, where can I have a reference of all the jemoji images and codes? Thanks.

Disable on some pages?

Hey there, I'm using the latest of Jekyll and jemoji and am wondering if I could disable it on some pages?

For instance, this has some generated information that turns into emoji were it doesn't really have to on the entire page:

emoji's are stretched

hi. my jekyll website on both gihub pages and locally displays emojis as stretched. see here. Do you have any idea what could be going on? Thanks.

Google custom Search is stripped

The google Custom Search tag ist removed by jemoji in Version 0.62
Please advise

<script>
(function() {
    var cx = '004003622068646069085:qqzmcbicy1k';
    var gcse = document.createElement('script');
    gcse.type = 'text/javascript';
    gcse.async = true;
    gcse.src = 'https://cse.google.com/cse.js?cx=' + cx;
    var s = document.getElementsByTagName('script')[0];
    s.parentNode.insertBefore(gcse, s);
  })();
</script>
<gcse:search></gcse:search>

Render actual emojis?

Would it be possible to make this plugin also work for something like πŸ–‹

That is using an emoji text rather than :pen:

Add ignore option

It would be great if code blocks could be ignored.
So no "emojies" are parsed inside this tag.

Render Emoji's inserted into page abstractly

A while back I started writing a small jQuery plugin that would convert WordPress.com emotes into Emojis for use on my (quite literally) blog feed for GHP. During development, I discovered that Emoji's are not rendered if they are injected into the page abstractly, meaning $.html(), $.append(), and the like. Instead, it is displayed as it is inserted, plain text. It works file if the Emoji code is already present in the HTML or .js file, but not if they are added from any other source (such as the developer tools or in my setup, pulling in the JSON feed containing the posts and using it for conversion).

My question is if it would be possible to support Emoji rendering if the Emoji was injected abstractly as I have exampled.

Thanks!

Ppessimisitc constraint necessary?

Dependency Error: Yikes! It looks like you don't have jemoji or one of its dependencies installed. In order to use Jekyll as currently configured, you'll need to install this gem. The full error message from Ruby is: 'Unable to activate activesupport-4.2.7.1, because json-2.0.3 conflicts with json (>= 1.7.7, ~> 1.7)' If you run into trouble, you can find helpful resources at http://jekyllrb.com/help/!

Shouldnt you remove the pessimisitc constraint?

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    πŸ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. πŸ“ŠπŸ“ˆπŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❀️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.