jekyll-openmoji 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: feafae4d43f234f09fd53145cecb85e01576094cf93bb3c8e4f634b4de847811
-  data.tar.gz: 41a679eece1e28437f9648577a03dd6d76821832c79985b1588fad0748ecba15
+  metadata.gz: 6b5c797f4f403a5d3e24703b151007f2da0bf444004f99890c76b94592a0c7a6
+  data.tar.gz: 4241d030fca03cd2497c71cafb5aa17598907451f93670110d80f76b68d926ad
 SHA512:
-  metadata.gz: 25bb9d69606825430382082770b89ce397708dbd62fe7f3ea31a80bc9e2f563881f7d7b2cf2d88b0dc662e71db40f94350af892519732dc59f6effd43fa2ac7f
-  data.tar.gz: a42f69fbbf331761f7dbd8929c8b502500780c2f2cb37999570d0f17b9ca710786ade103b8c982b1ff1a955feb28ac4869f3c98d3ecac57b3420ebfa8583144f
+  metadata.gz: a22bc4b22eb6e6eaa24c10b1e0ed74a65ea206fd64d84c0aceaeccf1da02bc1efe78f38751c128c1b74d044ad7936d49e38ed9b831a3f5031d1b3c88989ecd2e
+  data.tar.gz: 5695c62086f521489c47e6bf3589e1a751cd4b8892571aab76d676775b6703a17b1522cc7e89fbd5803e394e3c6694736bf2eaf17bcca8690efb5d9c14b04f44

data/.gitignore

@@ -46,7 +46,6 @@ build-iPhoneSimulator/
 ## Documentation cache and generated files:
 /.yardoc/
 /_yardoc/
-/doc/
 /rdoc/
 
 ## Environment normalization:

data/.gitlab-ci.yml

@@ -1,6 +1,7 @@
 # stages of gitlab ci.
 stages:
   - test
+  - deploy
   - release
 
 # default settings for all ci jobs.
@@ -88,6 +89,8 @@ test ruby 2.4:
   # run tests.
   script:
     - script/test.sh
+  except:
+    - tags
 
 test ruby 2.3:
   stage: test
@@ -106,6 +109,28 @@ test ruby 2.3:
   except:
     - tags
 
+# release a preview blog for master branch with gitlab pages.
+pages:
+  stage: deploy
+  script:
+    # setup rvm.
+    - source ~/.bash_profile
+    # use ruby version 2.6.
+    - rvm use 2.6
+    # go to blog folder.
+    - cd doc/blog
+    # upgrade bundler to latest version.
+    - gem install bundler
+    # install dependencies.
+    - bundle install --path vendor
+    # generate site with jekyll.
+    - bundle exec jekyll build --trace --destination ../../public
+  artifacts:
+    paths:
+      - public
+  only:
+    - master
+
 # deploy gems to rubygems.org whenever a tag is released.
 release to rubygems:
   stage: release

data/.rubocop.yml

@@ -9,6 +9,7 @@ AllCops:
   TargetRubyVersion: 2.3
   Exclude:
     - vendor/**/*
+    - doc/**/*
 
 Layout/AlignHash:
   EnforcedHashRocketStyle: table
@@ -18,7 +19,7 @@ Layout/MultilineMethodCallIndentation:
   IndentationWidth: 2
 
 Metrics/AbcSize:
-  Max: 25
+  Max: 30
 
 Metrics/BlockLength:
   Max: 50
@@ -32,6 +33,9 @@ Metrics/MethodLength:
 Style/HashSyntax:
   EnforcedStyle: hash_rockets
 
+Style/MutableConstant:
+  Enabled: false
+
 Style/RegexpLiteral:
   EnforcedStyle: percent_r
 

data/README.md

@@ -61,8 +61,8 @@
   <a title="Gem Version" href="https://rubygems.org/gems/jekyll-openmoji">
     <img src="https://img.shields.io/gem/v/jekyll-openmoji?color=red&label=Jekyll%20OpenMoji&logo=rubygems&style=flat-square" alt="Gem Version">
   </a>
-  <a title="jsDelivr CDN" href="https://www.jsdelivr.com/package/gh/azadeh=afzar/OpenMoji-Jekyll-Plugin">
-    <img src="https://data.jsdelivr.com/v1/package/gh/azadeh=afzar/OpenMoji-Jekyll-Plugin/badge" alt="jsDelivr CDN">
+  <a title="jsDelivr CDN" href="https://www.jsdelivr.com/package/gh/azadeh-afzar/OpenMoji-Jekyll-Plugin">
+    <img src="https://data.jsdelivr.com/v1/package/gh/azadeh-afzar/OpenMoji-Jekyll-Plugin/badge" alt="jsDelivr CDN">
   </a>
 </p>
 
@@ -83,6 +83,10 @@ their license.
 Use any available emoji package from a CDN or locally served emoji images by adding
 roughly 5 lines to your website's config file.
 
+## Preview
+
+see a preview of how OpenMoji emojis looks like with this plugin at this [**page**][preview].
+
 ## Quick start
 
 ### 1. Add the following to your site's `Gemfile`
@@ -106,6 +110,11 @@ In any page or post, use emoji as you would normally, e.g.
 I give this plugin two :+1:!
 ```
 
+with this plugin, Jekyll will turn this markdown code `:+1:` into this image:
+<img class="emoji" title="+1" alt="👍" src="https://cdn.jsdelivr.net/gh/azadeh-afzar/OpenMoji-Jekyll-Plugin@latest/images/color/svg/1f44d.svg" width="30em" height="30em" margin="0.5em"> .
+
+to see all codes and their emoji images, see preview [**page**][preview].
+
 ### Customizing
 
 If you'd like to serve emoji images locally, or use a custom emoji source,
@@ -126,9 +135,9 @@ emoji:
   # you can also provide an empty string "" if your source doesn't have any asset path.
   asset: "/color/png"
 
-  # final path will be  "https://www.emojisource.com/color/svg" and
+  # final path will be  "https://www.emojisource.com/color/png" and
   # emoji images will serve from this address.
-  # in case of no asset value, final path would be  "https://www.emojisource.com/color/svg"emoji
+  # in case of no asset value, final path would be  "https://www.emojisource.com/color/svg/emoji"
 
   # MORE CONFIGURATION OPTIONS
   # all configs below are optional.
@@ -136,8 +145,16 @@ emoji:
   # default emoji image extension is svg (vector file), but if your emoji source
   # images are in other formats, you can manually override default extension by using below key
   # and specify your desired extension (png, jpg, jpeg, bmp, etc).
-  extension: png
-
+  extension: "png"
+
+  # you can also provide default inline css properties for emoji images with img_attrs
+  # key, keep in mind that the keys must be valid css properties like padding, margin
+  # height, width, etc.
+  # below is a the default settings.
+  img_attrs:
+    class: "emoji"
+    height: "20"
+    width: "20"
 ```
 
 ## How it works
@@ -175,3 +192,5 @@ Licensed under the [GPLv3](LICENSE).
 1. All default emojis designed by [OpenMoji](https://openmoji.org) - the open source
 emoji and icon project. License: CC BY-SA 4.0
 2. This project is a fork of [Jemoji](https://github.com/jekyll/jemoji). License: MIT
+
+[preview]: https://azadeh-afzar.gitlab.io/Web-Development/OpenMoji-Jekyll-Plugin

data/doc/blog/.bundle/config

@@ -0,0 +1,2 @@
+---
+BUNDLE_PATH: "vendor"

data/doc/blog/404.html

@@ -0,0 +1,24 @@
+---
+layout: default
+---
+
+<style type="text/css" media="screen">
+  .container {
+    margin: 10px auto;
+    max-width: 600px;
+    text-align: center;
+  }
+  h1 {
+    margin: 30px 0;
+    font-size: 4em;
+    line-height: 1;
+    letter-spacing: -1px;
+  }
+</style>
+
+<div class="container">
+  <h1>404</h1>
+
+  <p><strong>Page not found :(</strong></p>
+  <p>The requested page could not be found.</p>
+</div>

data/doc/blog/Gemfile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+gem "jekyll", ">= 3.5", "< 5.0"
+gem "jekyll-feed", "~> 0.9"
+gem "jekyll-seo-tag", "~> 2.1"
+gem "jekyll-openmoji", "~> 0.1.0"

data/doc/blog/_config.yml

@@ -0,0 +1,16 @@
+title: OpenMoji Jekyll Plugin
+email: MahdiBaghbani@protonmail.com
+description: Bring beautiful OpenMoji emojis to your Jekyll websites.
+url: https://azadeh-afzar.gitlab.io
+baseurl: Web-Development/OpenMoji-Jekyll-Plugin
+
+minima:
+  social_links:
+    twitter: baghbani1
+    github:  MahdiBaghbani
+    gitlab: MahdiBaghbani
+
+plugins:
+  - jekyll-feed
+  - jekyll-seo-tag
+  - jekyll-openmoji

data/doc/blog/_includes/disqus_comments.html

@@ -0,0 +1,20 @@
+{%- if page.comments != false and jekyll.environment == "production" -%}
+
+  <div id="disqus_thread"></div>
+  <script>
+    var disqus_config = function () {
+      this.page.url = '{{ page.url | absolute_url }}';
+      this.page.identifier = '{{ page.url | absolute_url }}';
+    };
+
+    (function() {
+      var d = document, s = d.createElement('script');
+
+      s.src = 'https://{{ site.disqus.shortname }}.disqus.com/embed.js';
+
+      s.setAttribute('data-timestamp', +new Date());
+      (d.head || d.body).appendChild(s);
+    })();
+  </script>
+  <noscript>Please enable JavaScript to view the <a href="https://disqus.com/?ref_noscript" rel="nofollow">comments powered by Disqus.</a></noscript>
+{%- endif -%}

data/doc/blog/_includes/footer.html

@@ -0,0 +1,32 @@
+<footer class="site-footer h-card">
+  <data class="u-url" href="{{ "/" | relative_url }}"></data>
+
+  <div class="wrapper">
+
+    <div class="footer-col-wrapper">
+      <div class="footer-col one-half">
+      <h2 class="footer-heading">{{ site.title | escape }}</h2>
+        <ul class="contact-list">
+          <li class="p-name">
+            {%- if site.author -%}
+              {{ site.author | escape }}
+            {%- endif -%}
+            </li>
+            {%- if site.email -%}
+            <li><a class="u-email" href="mailto:{{ site.email }}">{{ site.email }}</a></li>
+            {%- endif -%}
+        </ul>
+      </div>
+
+      <div class="footer-col one-half">
+        <p>{{- site.description | escape -}}</p>
+      </div>
+
+      <div class="social-links">
+        {%- include social.html -%}
+      </div>
+    </div>
+
+  </div>
+
+</footer>

data/doc/blog/_includes/google-analytics.html

@@ -0,0 +1,9 @@
+<script async src="https://www.googletagmanager.com/gtag/js?id={{ site.google_analytics }}"></script>
+<script>
+  window['ga-disable-{{ site.google_analytics }}'] = window.doNotTrack === "1" || navigator.doNotTrack === "1" || navigator.doNotTrack === "yes" || navigator.msDoNotTrack === "1";
+  window.dataLayer = window.dataLayer || [];
+  function gtag(){dataLayer.push(arguments);}
+  gtag('js', new Date());
+
+  gtag('config', '{{ site.google_analytics }}');
+</script>

data/doc/blog/_includes/head.html

@@ -0,0 +1,11 @@
+<head>
+  <meta charset="utf-8">
+  <meta http-equiv="X-UA-Compatible" content="IE=edge">
+  <meta name="viewport" content="width=device-width, initial-scale=1">
+  {%- seo -%}
+  <link rel="stylesheet" href="{{ "/assets/css/style.css" | relative_url }}">
+  {%- feed_meta -%}
+  {%- if jekyll.environment == 'production' and site.google_analytics -%}
+    {%- include google-analytics.html -%}
+  {%- endif -%}
+</head>

data/doc/blog/_includes/header.html

@@ -0,0 +1,31 @@
+<header class="site-header">
+
+  <div class="wrapper">
+    {%- assign default_paths = site.pages | map: "path" -%}
+    {%- assign page_paths = site.header_pages | default: default_paths -%}
+    {%- assign titles_size = site.pages | map: 'title' | join: '' | size -%}
+    <a class="site-title" rel="author" href="{{ "/" | relative_url }}">{{ site.title | escape }}</a>
+
+    {%- if titles_size > 0 -%}
+      <nav class="site-nav">
+        <input type="checkbox" id="nav-trigger" class="nav-trigger" />
+        <label for="nav-trigger">
+          <span class="menu-icon">
+            <svg viewBox="0 0 18 15" width="18px" height="15px">
+              <path d="M18,1.484c0,0.82-0.665,1.484-1.484,1.484H1.484C0.665,2.969,0,2.304,0,1.484l0,0C0,0.665,0.665,0,1.484,0 h15.032C17.335,0,18,0.665,18,1.484L18,1.484z M18,7.516C18,8.335,17.335,9,16.516,9H1.484C0.665,9,0,8.335,0,7.516l0,0 c0-0.82,0.665-1.484,1.484-1.484h15.032C17.335,6.031,18,6.696,18,7.516L18,7.516z M18,13.516C18,14.335,17.335,15,16.516,15H1.484 C0.665,15,0,14.335,0,13.516l0,0c0-0.82,0.665-1.483,1.484-1.483h15.032C17.335,12.031,18,12.695,18,13.516L18,13.516z"/>
+            </svg>
+          </span>
+        </label>
+
+        <div class="trigger">
+          {%- for path in page_paths -%}
+            {%- assign my_page = site.pages | where: "path", path | first -%}
+            {%- if my_page.title -%}
+            <a class="page-link" href="{{ my_page.url | relative_url }}">{{ my_page.title | escape }}</a>
+            {%- endif -%}
+          {%- endfor -%}
+        </div>
+      </nav>
+    {%- endif -%}
+  </div>
+</header>

data/doc/blog/_includes/social.html

@@ -0,0 +1,19 @@
+{%- assign social = site.minima.social_links -%}
+
+<ul class="social-media-list">
+  {%- if social.dribbble -%}<li><a rel="me" href="https://dribbble.com/{{ social.dribbble | cgi_escape | escape }}" title="{{ social.dribbble | escape }}"><svg class="svg-icon grey"><use xlink:href="{{ '/assets/minima-social-icons.svg#dribbble' | relative_url }}"></use></svg></a></li>{%- endif -%}
+  {%- if social.facebook -%}<li><a rel="me" href="https://www.facebook.com/{{ social.facebook | cgi_escape | escape }}" title="{{ social.facebook | escape }}"><svg class="svg-icon grey"><use xlink:href="{{ '/assets/minima-social-icons.svg#facebook' | relative_url }}"></use></svg></a></li>{%- endif -%}
+  {%- if social.flickr -%}<li><a rel="me" href="https://www.flickr.com/photos/{{ social.flickr | cgi_escape | escape }}" title="{{ social.flickr | escape }}"><svg class="svg-icon grey"><use xlink:href="{{ '/assets/minima-social-icons.svg#flickr' | relative_url }}"></use></svg></a></li>{%- endif -%}
+  {%- if social.github -%}<li><a rel="me" href="https://github.com/{{ social.github | cgi_escape | escape }}" title="{{ social.github | escape }}"><svg class="svg-icon grey"><use xlink:href="{{ '/assets/minima-social-icons.svg#github' | relative_url }}"></use></svg></a></li>{%- endif -%}
+  {%- if social.instagram -%}<li><a rel="me" href="https://www.instagram.com/{{ social.instagram | cgi_escape | escape }}" title="{{ social.instagram | escape }}"><svg class="svg-icon grey"><use xlink:href="{{ '/assets/minima-social-icons.svg#instagram' | relative_url }}"></use></svg></a></li>{%- endif -%}
+  {%- if social.linkedin -%}<li><a rel="me" href="https://www.linkedin.com/in/{{ social.linkedin | cgi_escape | escape }}" title="{{ social.linkedin | escape }}"><svg class="svg-icon grey"><use xlink:href="{{ '/assets/minima-social-icons.svg#linkedin' | relative_url }}"></use></svg></a></li>{%- endif -%}
+  {%- if social.pinterest -%}<li><a rel="me" href="https://www.pinterest.com/{{ social.pinterest | cgi_escape | escape }}" title="{{ social.pinterest | escape }}"><svg class="svg-icon grey"><use xlink:href="{{ '/assets/minima-social-icons.svg#pinterest' | relative_url }}"></use></svg></a></li>{%- endif -%}
+  {%- for mst in social.mastodon -%}{%- if mst.username and mst.instance -%}<li><a rel="me" href="https://{{ mst.instance | cgi_escape | escape}}/@{{mst.username}}" title="{{ mst.username | escape }}"><svg class="svg-icon grey"><use xlink:href="{{ '/assets/minima-social-icons.svg#mastodon' | relative_url }}"></use></svg></a></li>{%- endif -%}{%- endfor -%}
+  {%- if social.twitter -%}<li><a rel="me" href="https://twitter.com/{{ social.twitter | cgi_escape | escape }}" title="{{ social.twitter | escape }}"><svg class="svg-icon grey"><use xlink:href="{{ '/assets/minima-social-icons.svg#twitter' | relative_url }}"></use></svg></a></li>{%- endif -%}
+  {%- if social.youtube -%}<li><a rel="me" href="https://www.youtube.com/{{ social.youtube | cgi_escape | escape }}" title="{{ social.youtube | escape }}"><svg class="svg-icon grey"><use xlink:href="{{ '/assets/minima-social-icons.svg#youtube' | relative_url }}"></use></svg></a></li>{%- endif -%}
+  {%- if social.youtube_channel -%}<li><a rel="me" href="https://www.youtube.com/channel/{{ social.youtube_channel | cgi_escape | escape }}" title="{{ social.youtube_channel_name | escape | default: 'YouTube' }}"><svg class="svg-icon grey"><use xlink:href="{{ '/assets/minima-social-icons.svg#youtube' | relative_url }}"></use></svg></a></li>{%- endif -%}
+  {%- if social.telegram -%}<li><a rel="me" href="https://t.me/{{ social.telegram | cgi_escape | escape }}" title="{{ social.telegram | escape }}"><svg class="svg-icon grey"><use xlink:href="{{ '/assets/minima-social-icons.svg#telegram' | relative_url }}"></use></svg></a></li>{%- endif -%}
+  {%- if social.keybase -%}<li><a rel="me" href="https://keybase.io/{{ social.keybase | cgi_escape | escape }}" title="{{ social.keybase | escape }}"><svg class="svg-icon grey"><use xlink:href="{{ '/assets/minima-social-icons.svg#keybase' | relative_url }}"></use></svg></a></li>{%- endif -%}
+  {%- if social.microdotblog -%}<li><a rel="me" href="https://micro.blog/{{ social.microdotblog | cgi_escape | escape }}" title="{{ social.microdotblog | escape }}"><svg class="svg-icon grey"><use xlink:href="{{ '/assets/minima-social-icons.svg#microdotblog' | relative_url }}"></use></svg></a></li>{%- endif -%}
+  {%- if social.rss -%}<li><a href="{{ 'feed.xml' | relative_url }}" title="{{ social.rss | escape }}"><svg class="svg-icon grey"><use xlink:href="{{ '/assets/minima-social-icons.svg#rss' | relative_url }}"></use></svg></a></li>{%- endif -%}
+</ul>

data/doc/blog/_layouts/default.html

@@ -0,0 +1,20 @@
+<!DOCTYPE html>
+<html lang="{{ page.lang | default: site.lang | default: "en" }}">
+
+  {%- include head.html -%}
+
+  <body>
+
+    {%- include header.html -%}
+
+    <main class="page-content" aria-label="Content">
+      <div class="wrapper">
+        {{ content }}
+      </div>
+    </main>
+
+    {%- include footer.html -%}
+
+  </body>
+
+</html>

data/doc/blog/_layouts/home.html

@@ -0,0 +1,38 @@
+---
+layout: default
+---
+
+<div class="home">
+  {%- if page.title -%}
+    <h1 class="page-heading">{{ page.title }}</h1>
+  {%- endif -%}
+
+  {{ content }}
+
+  {%- if site.posts.size > 0 -%}
+    <h2 class="post-list-heading">{{ page.list_title | default: "Posts" }}</h2>
+    <ul class="post-list">
+      {%- for post in site.posts -%}
+      <li>
+        {%- assign date_format = site.minima.date_format | default: "%b %-d, %Y" -%}
+        <span class="post-meta">{{ post.date | date: date_format }}</span>
+        <h3>
+          <a class="post-link" href="{{ post.url | relative_url }}">
+            {{ post.title | escape }}
+          </a>
+        </h3>
+        {%- if site.show_excerpts -%}
+          {{ post.excerpt }}
+        {%- endif -%}
+      </li>
+      {%- endfor -%}
+    </ul>
+
+    <p class="feed-subscribe">
+      <a href="{{ 'feed.xml' | relative_url }}">
+        <svg class="svg-icon orange"><use xlink:href="{{ 'assets/minima-social-icons.svg#rss' | relative_url }}"></use></svg><span>Subscribe</span>
+      </a>
+    </p>
+  {%- endif -%}
+
+</div>

data/doc/blog/_layouts/page.html

@@ -0,0 +1,14 @@
+---
+layout: default
+---
+<article class="post">
+
+  <header class="post-header">
+    <h1 class="post-title">{{ page.title | escape }}</h1>
+  </header>
+
+  <div class="post-content">
+    {{ content }}
+  </div>
+
+</article>

data/doc/blog/_layouts/post.html

@@ -0,0 +1,27 @@
+---
+layout: default
+---
+<article class="post h-entry" itemscope itemtype="http://schema.org/BlogPosting">
+
+  <header class="post-header">
+    <h1 class="post-title p-name" itemprop="name headline">{{ page.title | escape }}</h1>
+    <p class="post-meta">
+      <time class="dt-published" datetime="{{ page.date | date_to_xmlschema }}" itemprop="datePublished">
+        {%- assign date_format = site.minima.date_format | default: "%b %-d, %Y" -%}
+        {{ page.date | date: date_format }}
+      </time>
+      {%- if page.author -%}
+        • <span itemprop="author" itemscope itemtype="http://schema.org/Person"><span class="p-author h-card" itemprop="name">{{ page.author | escape }}</span></span>
+      {%- endif -%}</p>
+  </header>
+
+  <div class="post-content e-content" itemprop="articleBody">
+    {{ content }}
+  </div>
+
+  {%- if site.disqus.shortname -%}
+    {%- include disqus_comments.html -%}
+  {%- endif -%}
+
+  <a class="u-url" href="{{ page.url | relative_url }}" hidden></a>
+</article>