jekyll-dash 2.0.0 → 2.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f29e755db2527c979641ecb23c33b2f262c0f211584ec242afc77484d1c654f7
-  data.tar.gz: 805c3a368c4a96784046d9f787cf066b2d156eacdcf4e58609c7ae927e3bad2a
+  metadata.gz: becafdda8eaf7923084e20b2795dbe33ceb1c658f93039f0733125508a942ec0
+  data.tar.gz: 48ced63d493776ba8d39008f1e404479b25e72934ba20eb5509dc7a8b33bb659
 SHA512:
-  metadata.gz: 9d1bf17a0e6c40756660b888e7ba6c7f6262afd9999a9e2d29fbe7a054b3e77a2e4de7f442dbdf98a273a4e5aee28cc8c08a4f658897203fe11320aacbc93c27
-  data.tar.gz: e14db70d0eb5c5c3ecf4b0d9cb0bfb28ac73ecd3210fd3a86778656f23fcee48ab21eb7e9867c52dd29343ec232bc90915ca37f2c2e60282c6238a1cb13f7a12
+  metadata.gz: a7c2ad4d9876e91ec459e6f6d0fdf4870e102589649b83d1bb29e6464bdbe5ae6f14f8cef157456e1807648a5ff37e3ef471b8aa1a0709a72f92b1de9ad663bd
+  data.tar.gz: 85f4e0665738fd1b1f82a2533558f7a8327a03556bd87f9433fe33e9b072c1f1fe16b6741c482e2485652a7bbb6c8b6060f103b2b9ec29b6920fa7ad12c7b7da

data/README.md

@@ -3,27 +3,39 @@
 
 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 Tag](https://github.com/bitbrain/jekyll-dash/actions/workflows/build-tag.yml/badge.svg)
 [![license](https://img.shields.io/github/license/bitbrain/jekyll-dash.svg?style=flat-square)](LICENSE.MD)
+[![Gem](https://badgen.net/rubygems/v/jekyll-dash)](https://badgen.net/rubygems/v/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).
 
 [![design](theme.gif)](http://bitbrain.github.io)
 
+## Features
+
+#### :first_quarter_moon: Dark/Light Mode
+#### :arrow_left: Right-to-Left (RTL) Support
+#### :bookmark: Tags
+#### :orange_book: Pagination
+#### :computer: Syntax Highlighting
+#### :wave: Customisable Avatar Box
+#### :two_hearts: Social Links
+
 ## Installation
 
 Add this line to your Jekyll site's `Gemfile`:
 
 For **Jekyll 3**:
 ```ruby
-gem 'jekyll-dash', '~> 1.0.0'
+gem 'jekyll-dash', '~> 1'
 ```
 
 > Keep in mind: Github pages generation only supports Jekyll 3.8 right now.
 
 For **Jekyll 4**:
 ```ruby
-gem 'jekyll-dash', '~> 2.0.0'
+gem 'jekyll-dash', '~> 2'
 ```
 
 And add this line to your Jekyll site's `_config.yml`:
@@ -58,10 +70,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
@@ -75,21 +101,17 @@ dash:
     - url: https://github.com/bitbrain
       icon: github-square
       color: purple
-      
+  
+  # wether the author box should be displayed or not
   show_author: true
-
-# Replaces the default avatar provider (gravatar)
-#avatar_source: github
-#github_username: bitbrain
 ```
 ## 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!
 
@@ -121,6 +143,21 @@ 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.
+
+> I am getting an error 'cannot load such file --webrick' when trying to run `bundle exec jekyll serve`
+
+**Solution**
+
+As [explained here](https://github.com/jekyll/jekyll/issues/8523#issuecomment-751409319) this seems to be a bug with some recent Jekyll 4 version. To solve this simply run:
+```bash
+bundle add webrick
+```
+
 ## 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.
@@ -134,6 +171,8 @@ Your theme is setup just like a normal Jekyll site! To test your theme, run `bun
 When your theme is released, only the files in `_layouts`, `_includes`, `_sass` and `assets` tracked with Git will be bundled.
 To add a custom directory to your theme-gem, please edit the regexp in `jekyll-dash.gemspec` accordingly.
 
+> If you want to learn how Jekyll Dash gets deployed via Github Actions, feel free [to read this article](https://bitbra.in/2021/10/05/workflow-of-releasing-gem-based-jekyll-theme.html) written by me.
+
 ## License
 
 The theme is available as open source under the terms of the [Apache License 2.0](https://opensource.org/licenses/Apache-2.0).

data/_includes/author.html

@@ -1,15 +1,9 @@
 <div class="author-box">
-    {% if site.avatar_source == "github" and site.github_username %}
-        {% capture avatar_image %}
-            https://github.com/{{ site.github_username }}.png
-        {% 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 %}
-{{ site.description }}
+{% if site.dash.rtl %}
+<div class="description">{{ site.description }}</div>
+{%- include avatar.html -%}
+{% else %}
+{%- include avatar.html -%}
+<div class="description">{{ site.description }}</div>
+{% endif %}
 </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.dash.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,8 +21,8 @@ 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 %}

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;
 }