jekyll-dash 1.3.1 → 1.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e8bd89c0755e5356b45230261a258f5b2e0f30a6a0333ed3ff281d0e53035271
-  data.tar.gz: eb823e5bea6157a0db3b7a29b467048074e3dbc8e46bea8afbbe5edc768d4cb1
+  metadata.gz: 86f04b81ad4187386d150a31f2e56cbe2ff90b3e3f620fa00068686165b38eee
+  data.tar.gz: f1fcde4a0bfc7504360a2c899d193e72b6faba8fc729ad24e8500803033c70e5
 SHA512:
-  metadata.gz: 720501145ef7f3a3c609987ef0a3d36ce82fbb2406a0db4635c0c248c52cae3a0590568fd252b5f2001f85269383073b9f94889d10659182c5c104d312b68f86
-  data.tar.gz: 9f3f824725435d704428e9086640721383be090ef2932842a7b28fc360930765dfdce999ad77b981d531c9cef630fe3d89961cc1700984666bfcde1a76d9cda1
+  metadata.gz: f4d3461936484aa3e947105f009c4b9bd568cb7556293341cd0656f923788d5c51eb226d7b95636b3ed45e2b1d397ab96f7269492505ec3a1b55c73feb1a992d
+  data.tar.gz: fe410766ad9ae71ead6fee0f404be1df9b3edb936e3b1e9056a24b8d8cecd8687b0c4457c03fdf3932887f446a2f00d7c26de37c6cb698d380281386c4461e4d

data/README.md

@@ -5,6 +5,8 @@ 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)
 [![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.0.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
 
@@ -53,7 +63,7 @@ dash:
   date_format: "%b %-d, %Y"
 
   disqus:
-    shortname: <your-discuss-shortname>
+    shortname: <your-disqus-shortname>
 
   # generate social links in footer
   # supported colors: green, red, orange, blue, cyan, pink, teal, yellow, indigo, purple
@@ -67,10 +77,16 @@ dash:
     - url: https://github.com/bitbrain
       icon: github-square
       color: purple
+      
+  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` externally, for example on [TravisCI](https://travis-ci.org). 
 
 For example, you want to host your own blog on `https://<username>.github.io`. As a result, you require the following repositories:
 
@@ -107,6 +123,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,19 @@
 <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" />
-{% endif %}
+    {% 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 }}
 </div>

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/_includes/theme-toggle.html

@@ -16,13 +16,11 @@
 </div>
 <script type="text/javascript">
 const theme = localStorage.getItem('theme');
-if (theme === 'undefined') {
-   theme = "dark";
-}
-if (theme === "dark") {
-	document.documentElement.setAttribute('data-theme', 'dark');
-} else {
+
+if (theme === "light") {
     document.documentElement.setAttribute('data-theme', 'light');
+} else {
+    document.documentElement.setAttribute('data-theme', 'dark');
 }
 const userPrefers = getComputedStyle(document.documentElement).getPropertyValue('content');
 

data/_layouts/home.html

@@ -1,7 +1,10 @@
 ---
 layout: default
 ---
-{% include author.html %}
+{% 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>
@@ -18,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

@@ -1,7 +1,9 @@
 ---
 layout: default
 ---
-{% include author.html %}
+{% unless site.dash.show_author == false %}
+  {% include author.html %}
+{% endunless %}
 <div class="post">
   <h1 class="post-title">{{ page.title }}</h1>
   {% if site.plugins contains "jekyll/tagging" %}
@@ -13,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>
@@ -42,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

@@ -1,7 +1,9 @@
 ---
 layout: default
 ---
-{% include author.html %}
+{% unless site.dash.show_author == false %}
+  {% include author.html %}
+{% endunless %}
 <h1 class="post-title">articles tagged with <a class="tag" href="/tag/{{ page.tag }}/">{{ page.tag }}</a></h1>
   <div class="post-links">
   {% for post in site.posts %}
@@ -18,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/_icons.scss

@@ -1,9 +1,8 @@
 // Font Awesome Icons
 
-$icon-quote-right: "\f10e";
-$icon-chevron-right: "\f054";
-$icon-check: "\f00c";
-$icon-minus: "\f068";
-$icon-flask: "\f0c3";
-$icon-tag: "\f02b";
-$icon-lightbulb: "\f02b";
+$icon-quote-right: fa-content($fa-var-quote-right);
+$icon-chevron-right: fa-content($fa-var-chevron-right);
+$icon-check: fa-content($fa-var-check);
+$icon-minus: fa-content($fa-var-minus);
+$icon-flask: fa-content($fa-var-flask);
+$icon-tag: fa-content($fa-var-tag);

data/_sass/dash/_layout.scss

@@ -13,17 +13,12 @@
   .command_prompt {
     color: $color-blue;
     font-size: $base-font-size;
-
-    svg {
-      width: 20px;
-      height: 20px;
-      margin-bottom: -1px;
-      margin-left: 1px;
-    }
+    margin-left: 0.1em;
 
     &:before {
       content: $icon-chevron-right;
       @include font-awesome-icon;
+      margin-right: 0.2em;
     }
   }
 }
@@ -93,17 +88,10 @@
   @include themed() {
      color: t('foreground-color');
   }
-  white-space: nowrap;
   overflow: hidden;
   width: 100%;
-  animation: type 2s steps(60, end);
   margin-bottom: 1em;
-
-  & > svg {
-    color: $color-blue;
-    margin-right: 0.6em;
-    margin-bottom: -1px;
-  }
+  margin-left: 0.5em;
 
   &:after {
     content: "_";
@@ -114,6 +102,8 @@
   &:before {
     content: $icon-chevron-right;
     @include font-awesome-icon;
+    margin-right: 0.5em;
+    color: $color-blue;
   }
 }
 
@@ -155,17 +145,10 @@
     list-style: none;
     margin-left: 0;
 
-    svg {
-      @include themed() {
-        color: t('list-secondary');
-      }
-      margin-right: 0.65em;
-      margin-bottom: -1px;
-    }
-
     &:before {
       content: $icon-check;
       @include font-awesome-icon;
+      margin-right: 0.5em;
     }
   }
 
@@ -185,25 +168,18 @@
        color: t('quote-primary');
     }
 
+    & > p {
+        display: block;
+        padding-left: 3em;
+    }
+
     &:before {
       content: $icon-quote-right;
       @include font-awesome-icon;
-    }
-
-    & > svg.svg-inline--fa {
-      @include themed() {
-         color: t('quote-primary');
-      }
+      margin-right: -2em;
       float: left;
-      width: 3em;
-      height: 3em;
-      margin-right: 1em;
-    }
 
-    & > ul > li > svg {
-      @include themed() {
-         color: t('quote-primary');
-      }
+      font-size: 2em;
     }
 
     li {
@@ -213,10 +189,6 @@
       &:before {
         content: $icon-minus;
       }
-
-      & > svg {
-        margin-left: 2em;
-      }
     }
   }
 }
@@ -226,6 +198,8 @@
    & > .post-link {
      font-size: $base-font-size;
      font-size: $post-link-font-size;
+     display: inline-block;
+     text-align: initial;
    }
 
    & > .post-meta {
@@ -241,7 +215,7 @@
    text-align: left;
    & > a {
      display: inline-block;
-     margin-bottom: 1em;
+     margin: 0.3em 0.3em 0.3em 0;
    }
  }
 
@@ -260,19 +234,22 @@
     }
   }
 
-  & > svg {
-    margin-right: 0.4em;
-  }
-
   &:before {
     content: $icon-tag;
     @include font-awesome-icon;
+    margin-right: 0.5em;
   }
 }
 
+.tag {
+  display: inline-block;
+  margin: 0.3em 0.3em 0.3em 0;
+}
+
 .post-tags {
   margin-top: 0.3em;
   margin-bottom: 0.5em;
+  text-align: initial;
 }
 
 .credits {
@@ -304,10 +281,6 @@
     &:hover {
       text-decoration: none;
     }
-
-    svg {
-      padding-left: 0.1em;
-    }
   }
 
   & > a {
@@ -365,17 +338,11 @@ ul.related-posts {
       margin: 0;
     }
 
-    & > svg.svg-inline--fa {
-      color: $color-green;
-      margin-right: 0.3em;
-      width: 22px;
-      height: 22px;
-      margin-bottom: -2px;
-    }
-
     &:before {
       content: $icon-flask;
       @include font-awesome-icon;
+      color: $color-green;
+      margin-right: 0.5em;
     }
   }
 }
@@ -403,3 +370,7 @@ ul.related-posts {
         color: $color-yellow;
     }
 }
+
+.modal{
+  cursor: pointer;
+}

data/_sass/dash/_mixins.scss

@@ -5,8 +5,6 @@
   font-variant: normal;
   text-rendering: auto;
   font-weight: 900;
-
-  display: none;
   -webkit-font-smoothing: antialiased;
 }
 

data/_sass/dash/_themes.scss

@@ -3,7 +3,7 @@ $themes: (
                 background-color: $color-background-dark,
                 background-color-alt: $color-background-darker,
                 foreground-color: $color-foreground,
-                foreground-color-alt: $color-foreground-dark,
+                foreground-color-alt: lighten($color-foreground-dark, 10%),
                 foreground-color-contrast: white,
                 quote-primary: lighten($color-yellow, 20%),
                 quote-secondary: $color-yellow,

data/_sass/dash.scss

@@ -36,6 +36,7 @@ $spacing-unit: 30px !default;
 @import
   "fa/fontawesome",
   "fa/solid",
+  "fa/regular",
   "fa/brands",
   "dash/fonts",
   "dash/icons",