jekyll-dash 2.3.0 → 2.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 52dbc721d2c81abd048030551853ac06eead4bfdae0e3c12e3bc36690dc5a483
-  data.tar.gz: c589475b5cdd507f2ea776256adcec6ce5fd23cae7a0f5a65a0653fcfa1fb570
+  metadata.gz: 86176fed5582883183f08987c21b4e59cda96587cb1b219d6049faefe783d56b
+  data.tar.gz: 4e181fcc1be1fce2ef31f36d778c7d160c9e09901fae6ccf4d59effdb44117cc
 SHA512:
-  metadata.gz: f5718b2a53ec9758f9213a17d91be3aa8c408744c605761ce7b5b4979469815deebfcda6fd1b318e6dfcbb7eb7f2c8096f3c47bf1844ad7521627397023ab64e
-  data.tar.gz: 37ac09da251bfc186ce48c9181efe598408247d9ad04aafa8402c3be4018dec7fc15e3bb27f0f85c403ec3c933680e368e4dc8712f6933302b6d79f0d08df27e
+  metadata.gz: 6122cc2193e2a6582c891e29777e30b5bbd89c41adc8db089f9707d8c6d43d98cdbcdc3a6799306d609fa2352f072836fbad0704ca3aec5ea36f459c3a417382
+  data.tar.gz: 9fb1e8ddab0751f8d3585e58e758ca96d36fa0f54e0d973d24f2dda0f8e1e73aa8e8a1cf1266202a4cca24d5ca2cc5c247029c67ecf6ebeb53cd2d6189482854

data/README.md

@@ -4,15 +4,24 @@
 A dark and light theme for Jekyll, inspired by Dash UI for Atom. 🌒☀
 
 ![Build Tag](https://github.com/bitbrain/jekyll-dash/actions/workflows/build-tag.yml/badge.svg)
-![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")
+[![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`:
@@ -60,6 +69,9 @@ tag_permalink_style: pretty
 tag_page_layout: tag_page
 tag_page_dir: tag
 
+# for github pages custom domains:
+# include: [CNAME]
+
 dash:
   # the way how dates should be displayed
   date_format: "%b %-d, %Y"
@@ -106,6 +118,12 @@ I have created [a guide on how to set this up here](https://bitbra.in/2021/10/03
 
 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!
 
+If you are using a custom domain add in your main branch a file named CNAME with your domain there and uncomment this line in your config file:
+```
+include: [CNAME]
+```
+For more information about how to configure your CNAME file, read the [official documentation](https://docs.github.com/en/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site).
+
 ## Additional Features
 
 **Tagging** add the `jekyll/tagging` plugin to your `_config.yml` file to enable tagging. Do not forget to also add the following to your `Gemfile`:
@@ -140,6 +158,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.
@@ -153,6 +180,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/avatar.html

@@ -1,6 +1,6 @@
 {% if site.dash.avatar_source == "github" and site.dash.github_username %}
 {% capture avatar_image %}
-    https://github.com/{{ site.github_username }}.png
+    https://github.com/{{ site.dash.github_username }}.png
 {% endcapture %}
 {% elsif site.dash.avatar_source == "local" and site.dash.avatar_path %}
 {% capture avatar_image %}

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

@@ -4,7 +4,7 @@ layout: default
 {% 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>
+<h1 class="post-title">articles tagged with <a class="tag" href="{{ page.tag | tag_url }}">{{ page.tag }}</a></h1>
   <div class="post-links">
   {% for post in site.posts %}
   {% for tag in post.tags %}
@@ -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 %}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-dash
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.3.3
 platform: ruby
 authors:
 - Miguel Gonzalez Sanchez
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-10-06 00:00:00.000000000 Z
+date: 2022-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll