jekyll-dash 2.1.0 → 2.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a09901cd8a5c824d2abe303c081155c13caf9e391e7686a8635051ad727e4fbf
-  data.tar.gz: feffa0f63ae250b87f5069abab013d892a061e464a2adef914723e36d945a21a
+  metadata.gz: d4b0d408e8c2385413ac3386e6fefd4767b80c6fa023b129d702448e54abf605
+  data.tar.gz: 96d8601fdb46b995a4419f10ea207ce51461460fe6a08715e1e53ec3ff90dca5
 SHA512:
-  metadata.gz: df3dde9fd0354defd85f986c61994d016f24e15f5bd8d450dfed91db753e64af2813d9818da1a96000434f3332c1b33aefa0f6a10d2fc1b78f847fe426824356
-  data.tar.gz: 39966c9f4fa428f0bce73e0c4676fa38b9576e3590083799bd0597a6e460fe3680392f04f41725721bdb687f626c7eea9b771441d2413ba0168e081fdc637c98
+  metadata.gz: 272d5349e5e05e5d86fb983f0972b7439195ec5a3f51fe44b1dfb43a109d82cf0925bb7d23be8639cecb48662d527573cea28d44d81d44967a91e16299d4d93b
+  data.tar.gz: 835f090778f1f5bd9ce2d82666f11284121fefd0494a40330e4897ebc04e6d63183d39cbb5e02402c10c9597634f3d3dd0241b204d4ea603f7b499c69d6b985b

data/README.md

@@ -3,29 +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://img.shields.io/gem/v/jekyll-dash.svg?style=flat)](http://rubygems.org/gems/jekyll-dash "View this project in Rubygems")
+[![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`:
@@ -60,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
@@ -77,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://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` 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!
 
@@ -129,6 +149,15 @@ gem "liquid-md5"
 
 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.
@@ -142,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,19 +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.avatar_source == "local" and site.avatar_path %}
-        {% capture avatar_image %}
-            {{site.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 %}
-{{ 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/_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

@@ -17,7 +17,7 @@ layout: default
             {% if site.plugins contains "jekyll/tagging" %}
             <div class="post-tags">
                 {% for tag in post.tags %}
-                <a class="tag" href="/tag/{{ tag }}/">{{ tag }}</a>
+                <a class="tag" href="{{ tag | tag_url }}">{{ tag }}</a>
                 {% endfor %}
             </div>
             {% endif %}

data/_layouts/post.html

@@ -9,7 +9,7 @@ layout: default
   {% if site.plugins contains "jekyll/tagging" %}
   <div class="post-tags">
       {% for tag in page.tags %}
-      <a class="tag" href="/tag/{{ tag }}/">{{ tag }}</a>
+      <a class="tag" href="{{ tag | tag_url }}">{{ tag }}</a>
       {% endfor %}
   </div>
   {% endif %}

data/_layouts/tag_page.html

@@ -17,7 +17,7 @@ layout: default
 
           <div class="post-tags">
               {% for tag in post.tags %}
-              <a class="tag" href="/tag/{{ tag }}/">{{ tag }}</a>
+              <a class="tag" href="{{ tag | tag_url }}">{{ tag }}</a>
               {% endfor %}
           </div>
           {% if site.dash.date_format %}

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;
    }
  }
 
@@ -169,7 +223,7 @@
     }
 
     & > p {
-        display: block;
+        display: inline-block;
         padding-left: 3em;
     }
 
@@ -182,6 +236,10 @@
       font-size: 2em;
     }
 
+    & > ul {
+      margin-left: 3em;
+    }
+
     li {
       @include themed() {
          color: t('quote-secondary');

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-dash
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.3.2
 platform: ruby
 authors:
 - Miguel Gonzalez Sanchez
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-10-03 00:00:00.000000000 Z
+date: 2021-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -104,6 +104,7 @@ files:
 - LICENSE
 - README.md
 - _includes/author.html
+- _includes/avatar.html
 - _includes/disqus.html
 - _includes/footer.html
 - _includes/head.html