jekyll-dash 1.3.4 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 076ebeba1856c2e67b9335c861a3e3703be901f642adf07a32bfa7f6b38c535f
-  data.tar.gz: b2b199bf7876a1e0064c080367c01cf1af09d3ce538a3b563dca92fd0ebaa25f
+  metadata.gz: df0f39301e659c4eccf39d3ea95fe379240e09eed9263115231eb12bbf689572
+  data.tar.gz: fa83e2b057f22f867a404c574115cef12c3f95b61851f646b59e1ebd90d3ff12
 SHA512:
-  metadata.gz: 1875923346d684204e9ac255786b9d029ce60bbf992484bdf73e221450d35852f281ab4411dc6c29b6e819a005f05debacb813600626d14ce9ae77caac8508f7
-  data.tar.gz: bebbfed3f7ce2b5c35f7bfeff5fba5f861facc8d5188d426c0973a8e01269e197abcbe9536f3ef4074e6b17d819a0f70d4ce3c5591f2fa43eb4db0b025e7dc33
+  metadata.gz: '081d5172841184bbbcf307ed86e4c86423ed73e9d17f82da6d2cb328103e54c4724fc3259e01a8846e67f60ad9aa61e2c91d58f2b24c85901d39b190ad2b3776'
+  data.tar.gz: ed45a3941b0cc37de4280e8d7ba1f8228553e2686acc4a5636ce08453ca5e14bfd0755881a366b468dd85fc39e2385d061cbfb3cdc25a6cb595d97ebd8241cf1

data/README.md

@@ -3,8 +3,10 @@
 
 A dark and light theme for Jekyll, inspired by Dash UI for Atom. 🌒☀
 
-[![Build Status](https://img.shields.io/travis/bitbrain/braingdx/master.svg?logo=travis&style=flat-square)](https://travis-ci.org/bitbrain/jekyll-dash)
+![Build Status](https://github.com/bitbrain/jekyll-dash/actions/workflows/release-gem.yml/badge.svg)
 [![license](https://img.shields.io/github/license/bitbrain/jekyll-dash.svg?style=flat-square)](LICENSE.MD)
+[![Gem](https://img.shields.io/gem/v/jekyll-dash.svg?style=flat)](http://rubygems.org/gems/jekyll-dash "View this project in Rubygems")
+[![Downloads](https://ruby-gem-downloads-badge.herokuapp.com/jekyll-dash)](https://rubygems.org/gems/jekyll-dash "Number of Gem downloads")
 ---
 This theme for [Jekyll](https://jekyllrb.com/) has been inspired by [dash-ui](https://atom.io/themes/dash-ui), a dark theme for [Atom](https://atom.io).
 
@@ -14,8 +16,16 @@ This theme for [Jekyll](https://jekyllrb.com/) has been inspired by [dash-ui](ht
 
 Add this line to your Jekyll site's `Gemfile`:
 
+For **Jekyll 3**:
 ```ruby
-gem "jekyll-dash"
+gem 'jekyll-dash', '~> 1.0.0'
+```
+
+> Keep in mind: Github pages generation only supports Jekyll 3.8 right now.
+
+For **Jekyll 4**:
+```ruby
+gem 'jekyll-dash', '~> 2.1.0'
 ```
 
 And add this line to your Jekyll site's `_config.yml`:
@@ -30,7 +40,7 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install jekyll-dash
+    $ gem install jekyll-dash -v version
 
 ## Configuration
 
@@ -50,10 +60,24 @@ tag_page_layout: tag_page
 tag_page_dir: tag
 
 dash:
+  # the way how dates should be displayed
   date_format: "%b %-d, %Y"
 
+  # (optional) discqus comment configuration
   disqus:
-    shortname: <your-disqus-shortname>
+    shortname: <your-disqus-shortname>  
+
+  # the animation speed of the post scroll-in effect
+  animation_speed: 50
+
+  # wether to enable Right-to-Left support or not
+  rtl: false
+
+  # Replaces the default avatar provider (gravatar)
+  #avatar_source: github
+  #github_username: bitbrain
+  #avatar_source: local
+  #avatar_path: /assets/avatar.png
 
   # generate social links in footer
   # supported colors: green, red, orange, blue, cyan, pink, teal, yellow, indigo, purple
@@ -67,17 +91,17 @@ dash:
     - url: https://github.com/bitbrain
       icon: github-square
       color: purple
-      
+  
+  # wether the author box should be displayed or not
   show_author: true
 ```
 ## Using this theme directly on Github Pages
 
-Please keep in mind that Github Pages does only support [a limited list of Jekyll plugins](https://help.github.com/en/articles/configuring-jekyll-plugins#default-plugins). You will be able to use this theme on Github Pages but some functionality might not be available, for example displaying tags. In order to use this theme to a full extend, you have to generate the `_site` externally, for example on [TravisCI](https://travis-ci.org). 
+Please keep in mind that Github Pages does only support [a limited list of Jekyll plugins](https://pages.github.com/versions/). You will be able to use this theme on Github Pages but some functionality might not be available, for example displaying tags. In order to use this theme to a full extend, you have to generate the `_site` [separately via Github Actions](https://jekyllrb.com/docs/continuous-integration/github-actions/).
 
-For example, you want to host your own blog on `https://<username>.github.io`. As a result, you require the following repositories:
+* `<username>.github.io` - contains main source branch and orphan gh-pages branch ([see example](https://github.com/bitbrain/bitbrain.github.io))
 
-* `blog` - contains the actual Jekyll sources ([see example](https://github.com/bitbrain/blog))
-* `<username>.github.io` - contains generated webpage, pushed automatically via TravisCI ([see example](https://github.com/bitbrain/bitbrain.github.io))
+I have created [a guide on how to set this up here](https://bitbra.in/2021/10/03/host-your-own-blog-for-free-with-custom-domain.html).
 
 You are not required to do this, but keep in mind that some functionality might not be available when using the Jekyll generator on Github directly!
 
@@ -109,6 +133,12 @@ gem "liquid-md5"
 
 **Solution**: as described above you have to add the tagging plugin. Additionally, tags do not work natively by Github Pages. You have to build your site on an external CI and push the `_site` artifacts to a hosting repository.
 
+> I am getting an error that Bundler could not find compatible versions for gem
+
+**Solution**
+
+Make sure you are using a version of this theme that is compatible with Jekyll. Version 1.x is only compatible with Jekyll 3.x while Version 2.x is only compatible with Jekyll 4.x.
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/bitbrain/jekyll-dash. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

data/_includes/author.html

@@ -1,6 +1,9 @@
 <div class="author-box">
-{% if site.plugins contains "liquid-md5" %}
-<img src="https://gravatar.com/avatar/{{ site.email | downcase | md5 }}?s=256" class="author-avatar" />
+{% if site.dash.rtl %}
+<div class="description">{{ site.description }}</div>
+{%- include avatar.html -%}
+{% else %}
+{%- include avatar.html -%}
+<div class="description">{{ site.description }}</div>
 {% endif %}
-{{ site.description }}
 </div>

data/_includes/avatar.html

@@ -0,0 +1,16 @@
+{% if site.dash.avatar_source == "github" and site.dash.github_username %}
+{% capture avatar_image %}
+    https://github.com/{{ site.github_username }}.png
+{% endcapture %}
+{% elsif site.dash.avatar_source == "local" and site.dash.avatar_path %}
+{% capture avatar_image %}
+    {{site.dash.avatar_path}}
+{% endcapture %}
+{% elsif site.plugins contains "liquid-md5" %}
+{% capture avatar_image %}
+    https://gravatar.com/avatar/{{ site.email | downcase | md5 }}?s=256
+{% endcapture %}
+{% endif %}
+{% if avatar_image %}
+<img src="{{ avatar_image }}" class="author-avatar" alt="Avatar" />
+{% endif %}

data/_includes/head.html

@@ -5,8 +5,11 @@
   {%- seo -%}
   <link rel="stylesheet" href="{{ "/assets/css/style.css" | relative_url }}">
   <link rel="icon" type="image/png" href="{{ "/assets/favicon.png" | relative_url }}" />
+  <link rel="stylesheet" href="{{ "/assets/css/magnific-popup.css" | relative_url }}">
   {%- feed_meta -%}
   {%- if jekyll.environment == 'production' and site.google_analytics -%}
     {%- include google-analytics.html -%}
   {%- endif -%}
+  <script src="https://code.jquery.com/jquery-3.2.0.min.js"></script> 
+  <script src="{{ "/assets/js/jquery.magnific-popup.js" | relative_url }}"></script>
 </head>

data/_includes/header.html

@@ -2,7 +2,13 @@
   <div class="wrapper">
     <a class="site-title" rel="author" href="{{ "/" | relative_url }}">{{ site.title | escape }}<b class="command_prompt"></b><b class="blinking_cursor">_</b></a>
     <span class="social_links">
-        {% for link in site.dash.social_links %}<a class="color-{{ link.color }}-hover" href="{{ link.url }}"><i class="fab fa-{{ link.icon }}"></i></a>{% endfor %}
+        {% for link in site.dash.social_links %}
+        {% if link.fa == true %}
+        <a class="color-{{ link.color }}-hover" href="{{ link.url }}"><i class="fa fa-{{ link.icon }}"></i></a>
+        {% else %}
+        <a class="color-{{ link.color }}-hover" href="{{ link.url }}"><i class="fab fa-{{ link.icon }}"></i></a>
+        {% endif %}
+        {% endfor %}
     </span>
   </div>
 </div>

data/_layouts/default.html

@@ -1,5 +1,5 @@
 <!DOCTYPE html>
-<html lang="{{ page.lang | default: site.lang | default: "en" }}">
+<html class="{% if site.dash.rtl %}direction--rtl{% else %}direction--ltr{% endif %}"lang="{{ page.lang | default: site.lang | default: "en" }}">
 
   {%- include head.html -%}
 

data/_layouts/home.html

@@ -4,6 +4,7 @@ layout: default
 {% unless site.dash.show_author == false %}
   {% include author.html %}
 {% endunless %}
+{{ content }}
 {% assign posts_count = paginator.posts | size %}
 {% if posts_count > 0 %}
 <h1>recent articles</h1>
@@ -20,11 +21,16 @@ layout: default
                 {% endfor %}
             </div>
             {% endif %}
-            {% if site.date_format %}
-              {{ post.date | date: site.date_format }}
+            {% if site.dash.date_format %}
+              {{ post.date | date: site.dash.date_format }}
             {% else %}
               {{ post.date | date: "%b %-d, %Y" }}
             {% endif %}
+            {% if site.show_excerpts == true %}
+              <div class="post-excerpt">
+                {{ post.content | strip_html | truncatewords: 50 }}
+              </div>
+            {% endif %}
           </div>
         </div>
       {% endfor %}

data/_layouts/post.html

@@ -15,7 +15,10 @@ layout: default
   {% endif %}
   <div class="post-date">Published on {{ page.date | date_to_string }}</div>
   {% if page.description != null %}
-  <div class="post-description">{{ page.description }}</div>
+  <noscript>
+    <div class="post-description">{{ page.description }}</div>
+  </noscript>
+  <div id="animated-post-description" class="post-description" style="display: none;"></div>
   {% endif %}
   {{ content }}
 </div>
@@ -44,3 +47,45 @@ layout: default
 </div>
 {% endif %}
 {% include tagcloud.html %}
+
+{% assign animation_speed = site.dash.animation_speed | default: 50 %}
+<script>
+  let i = 0;
+  const text = '{{ page.description }}';
+  const speed = parseInt('{{ animation_speed }}');
+  
+  function typeWriter() {
+    if (i < text.length) {
+      document.getElementById('animated-post-description').innerHTML += text.charAt(i);
+      i++;
+      setTimeout(typeWriter, speed);
+    }
+  }
+
+  document.getElementById('animated-post-description').style.display = 'initial';
+  typeWriter();
+
+  // Image modal
+  var $imgs = [];
+  $('img').each(function(idx) {
+    var obj = {
+      src: $(this).attr('src')
+    }
+    $imgs.push(obj);
+    var elem = $(this);
+    $(this).click(function() {
+      $('.modal').magnificPopup('open', idx);
+    });
+  });
+
+  $('.modal').magnificPopup({
+    items: $imgs,
+    type: 'image',
+    closeOnContentClick: true,
+    mainClass: 'mfp-img-mobile',
+    image: {
+      verticalFit: true
+    }
+    
+  });
+</script>

data/_layouts/tag_page.html

@@ -20,8 +20,8 @@ layout: default
               <a class="tag" href="/tag/{{ tag }}/">{{ tag }}</a>
               {% endfor %}
           </div>
-          {% if site.date_format %}
-            {{ post.date | date: site.date_format }}
+          {% if site.dash.date_format %}
+            {{ post.date | date: site.dash.date_format }}
           {% else %}
             {{ post.date | date: "%b %-d, %Y" }}
           {% endif %}

data/_sass/dash/_layout.scss

@@ -52,21 +52,75 @@
 }
 
 /**
- * Author box
+ * Right-to-Left support
  */
 
+ html.direction--rtl {
+  .author-box {
+    text-align: right;
+    & > .description {
+      direction: rtl;
+    }
+    & > img {
+      margin-right: 0em;
+      margin-left: 1em;
+    }
+  }
+  ol > li, ul > li {
+    text-align: right;
+    direction: rtl;
+    &::before {
+      float: right;
+      margin-left: 0.5em;
+    }
+  }
+  h1, h2, h3, h4, h5, h6 {
+    direction: rtl;
+    text-align: right;
+  }
+  .post-link-wrapper {
+    direction: rtl;
+  }
+  .post {
+    direction: rtl;
+  }
+  .pagination {
+    text-align: right;
+  }
+  .tag-cloud {
+    direction: rtl;
+    text-align: right;
+  }
+  .related-posts {
+    direction: rtl;
+    text-align: right;
+
+    & > li::before {
+      margin-right: 0;
+      margin-left: 0.5em;
+    }
+  }
+  pre {
+    direction: ltr;
+    text-align: left;
+  }
+}
+
  .author-box {
    margin-bottom: 1em;
    text-align: left;
    min-height: 72px;
    font-style: italic;
+   display: inline-flex;
+   & > .description {
+     flex:8;
+   }
    & > .author-avatar {
-     float: left;
-     white-space: pre-line;
      margin-right: 1em;
      width: 72px;
-     height: 72px;
+     height: 100%;
      border-radius: 0.3em;
+     flex: 1;
    }
  }
 
@@ -88,10 +142,8 @@
   @include themed() {
      color: t('foreground-color');
   }
-  white-space: nowrap;
   overflow: hidden;
   width: 100%;
-  animation: type 2s steps(60, end);
   margin-bottom: 1em;
   margin-left: 0.5em;
 
@@ -171,7 +223,7 @@
     }
 
     & > p {
-        display: block;
+        display: inline-block;
         padding-left: 3em;
     }
 
@@ -184,6 +236,10 @@
       font-size: 2em;
     }
 
+    & > ul {
+      margin-left: 3em;
+    }
+
     li {
       @include themed() {
          color: t('quote-secondary');
@@ -371,4 +427,8 @@ ul.related-posts {
         }
         color: $color-yellow;
     }
+}
+
+.modal{
+  cursor: pointer;
 }