Merge branch 'main' into 2.x

bitbrain · bitbrain · commit 509ab7f43b67 · 2021-10-03T12:22:31.000+01:00
diff --git a/.github/workflows/build-branch.yml b/.github/workflows/build-branch.yml
@@ -0,0 +1,24 @@
+name: Build Branch
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    if: github.ref != 'refs/heads/main'
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.6', '2.7', '3.0']
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+    # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@473e4d8fe5dd94ee328fdfca9f8c9c7afc9dae5e
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true
+    - name: Run tests
+      run: bundle exec rake
diff --git a/.github/workflows/release-gem.yml b/.github/workflows/release-gem.yml
@@ -0,0 +1,15 @@
+name: Build Branch
+
+on: [push]
+
+jobs:
+  release:
+    if: github.ref == 'refs/heads/main'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+      - name: Release gem
+        uses: dawidd6/action-publish-gem@v1
+        with:
+          github_token: ${{secrets.GH_CREDENTIALS}}
+          api_key: ${{secrets.RUBYGEMS_API_KEY}}
diff --git a/.gitignore b/.gitignore
@@ -1,6 +1,7 @@
 _site
 .sass-cache
 .jekyll-metadata
+.jekyll-cache
 Gemfile.lock
 *.gem
 *.idea
diff --git a/.travis.yml b/.travis.yml
diff --git a/Gemfile b/Gemfile
@@ -2,5 +2,6 @@ source "https://rubygems.org"
 
 gem "liquid-md5"
 gem "jekyll-tagging"
+gem "kramdown-parser-gfm"
 
 gemspec
diff --git a/README.md b/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).
 
@@ -84,7 +86,7 @@ dash:
 ```
 ## 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:
 
@@ -121,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.
diff --git a/Rakefile b/Rakefile
@@ -0,0 +1,22 @@
+# coding: utf-8
+require 'jekyll'
+
+# Extend string to allow for bold text.
+class String
+  def bold
+    "\033[1m#{self}\033[0m"
+  end
+end
+
+# Rake Jekyll tasks
+task :build do
+  puts 'Building site...'.bold
+  Jekyll::Commands::Build.process(profile: true)
+end
+
+task :clean do
+  puts 'Cleaning up _site...'.bold
+  Jekyll::Commands::Clean.process({})
+end
+
+task :default => :build
diff --git a/_config.yml b/_config.yml
@@ -37,6 +37,8 @@ dash:
 
   show_author: true
 
+  animation_speed: 50
+
 # Build settings
 theme: jekyll-dash
 
@@ -50,3 +52,5 @@ plugins:
 # Replaces the default avatar provider (gravatar)
 #avatar_source: github
 #github_username: bitbrain
+#avatar_source: local
+#avatar_path: /assets/avatar.png
diff --git a/_includes/author.html b/_includes/author.html
@@ -3,6 +3,10 @@
         {% 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
diff --git a/_includes/head.html b/_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>
diff --git a/_includes/header.html b/_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>
diff --git a/_layouts/home.html b/_layouts/home.html
@@ -4,6 +4,7 @@
 {% 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 @@ <h1>recent articles</h1>
                 {% 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 %}
diff --git a/_layouts/post.html b/_layouts/post.html
@@ -15,7 +15,10 @@ <h1 class="post-title">{{ page.title }}</h1>
   {% 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 @@ <h3>
 </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>
diff --git a/_layouts/tag_page.html b/_layouts/tag_page.html
@@ -20,8 +20,8 @@ <h1 class="post-title">articles tagged with <a class="tag" href="/tag/{{ page.ta
               <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 %}
diff --git a/_posts/2019-04-16-welcome-to-jekyll2.md b/_posts/2019-04-16-welcome-to-jekyll2.md
@@ -41,7 +41,7 @@ print_hi('Tom')
 
 Pictures look like this:
 
-![image](https://picsum.photos/200)
+![image](https://picsum.photos/200){: .modal}
 
 Check out the [Jekyll docs][jekyll-docs] for more info on how to get the most out of Jekyll. File all bugs/feature requests at [Jekyll’s GitHub repo][jekyll-gh]. If you have questions, you can ask them on [Jekyll Talk][jekyll-talk].
 
diff --git a/_sass/dash/_layout.scss b/_sass/dash/_layout.scss
@@ -88,10 +88,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;
 
@@ -371,4 +369,8 @@ ul.related-posts {
         }
         color: $color-yellow;
     }
+}
+
+.modal{
+  cursor: pointer;
 }
diff --git a/assets/avatar.png b/assets/avatar.png
diff --git a/assets/css/magnific-popup.css b/assets/css/magnific-popup.css
diff --git a/assets/js/jquery.magnific-popup.js b/assets/js/jquery.magnific-popup.js
diff --git a/assets/js/jquery.magnific-popup.min.js b/assets/js/jquery.magnific-popup.min.js
diff --git a/jekyll-dash.gemspec b/jekyll-dash.gemspec
