jekyll-theme-chirpy 3.0.3 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6d1deb397c90c655e4dd568846ead4b81dbd2df583f824376881ff3742c786fb
-  data.tar.gz: 2969990a0e9dd0d6f29c84b0e7ab3524c4826129839e56bbc26f2ffcd4444987
+  metadata.gz: a6e95f5a798562bf2d4bb37251a70cb3c2a20d137c57e0bf0160c32c68418738
+  data.tar.gz: a91318d6031acec809319bbaaa5619a9b62be8618c5a61f7b57de7ac27a80ca4
 SHA512:
-  metadata.gz: ffbb1857e75f93898afa0460b30b4c7103a21880da05649356a040ca6c5b1aff62a0b9cfcaf381045ca30d7bf06706e21a5775051dfa7083e01b4d9a81746ba1
-  data.tar.gz: 52eeecada99b630956f16d643c6d7f05d971828fb1f75c89d74764efe9161a04fc0093f6903e63c44b5fa8ecccc9d8c086ba4007f061e486433ef1e3afbfa49f
+  metadata.gz: 37f59d4ebac543e73d0b1a9dbd190f939c910c3b8f44a989f012f2cc59c190c729e84554bdff197a52e4df7c54e07355a8c12273deecf0defd6b6da43c4888dd
+  data.tar.gz: 4d69ec49ac10c5a40c1f0a232b39f11be692a57814602ecc025c1aa7036e66e750a22bf574f59e32e3f2755e4a3cef6203ac3f2f683649891b482c0023769db2

data/404.html

@@ -6,9 +6,6 @@ permalink: /404.html
 redirect_from:
   - /norobots/
   - /assets/
-  - /tabs/
-  - /categories/
-  - /tags/
   - /posts/
 
 dynamic_title: true
@@ -16,5 +13,9 @@ dynamic_title: true
 
 <div class="lead">
   <p>Sorry, we've misplaced that URL or it's pointing to something that doesn't exist. </p>
-  <p><a href="{{ site.baseurl }}/">Head back Home</a> to try finding it again, or search for it on the <a href="{{ site.baseurl }}/tabs/archives">Archives page</a>.</p>
+  <p>
+    <a href="{{ '/' | relative_url }}">Head back Home</a>
+    to try finding it again, or search for it on the
+    <a href="{{ 'archives' | relative_url }}">Archives page</a>.
+  </p>
 </div>

data/README.md

@@ -2,9 +2,10 @@
 
 Language: English | [简体中文](https://github.com/cotes2020/jekyll-theme-chirpy/blob/master/docs/README.zh-CN.md)
 
+[![Gem Version](https://img.shields.io/gem/v/jekyll-theme-chirpy?color=brightgreen)](https://rubygems.org/gems/jekyll-theme-chirpy)
 [![Build Status](https://github.com/cotes2020/jekyll-theme-chirpy/workflows/build/badge.svg?branch=master&event=push)](https://github.com/cotes2020/jekyll-theme-chirpy/actions?query=branch%3Amaster+event%3Apush)
 [![Codacy Badge](https://api.codacy.com/project/badge/Grade/8220b926db514f13afc3f02b7f884f4b)](https://app.codacy.com/manual/cotes2020/jekyll-theme-chirpy?utm_source=github.com&utm_medium=referral&utm_content=cotes2020/jekyll-theme-chirpy&utm_campaign=Badge_Grade_Dashboard)
-[![GitHub license](https://img.shields.io/github/license/cotes2020/jekyll-theme-chirpy.svg)](https://github.com/cotes2020/jekyll-theme-chirpy/blob/master/LICENSE)
+[![GitHub license](https://img.shields.io/github/license/cotes2020/jekyll-theme-chirpy.svg?color=blue)](https://github.com/cotes2020/jekyll-theme-chirpy/blob/master/LICENSE)
 [![996.icu](https://img.shields.io/badge/link-996.icu-%23FF4D5B.svg)](https://996.icu)
 
 A minimal, sidebar, responsive web design Jekyll theme that focuses on text presentation. Designed to help you record and share your knowledge easily. [Live Demo »](https://chirpy.cotes.info)
@@ -49,10 +50,10 @@ Follow the [Jekyll Docs](https://jekyllrb.com/docs/installation/) to complete th
 
 There are two ways to get the theme:
 
-- Install from [RubyGems](https://rubygems.org/gems/jekyll-theme-chirpy)
-- Fork from GitHub
+- **Install from RubyGems** - Easy to upgrade, isolate irrelevant project files so you can focus on writing.
+- **Fork from GitHub** - Convenient for custom development, but difficult to upgrade, only suitable for web developers.
 
-### Install From Rubygems
+### Install From RubyGems
 
 Add this line to your Jekyll site's `Gemfile`:
 
@@ -72,15 +73,15 @@ And then execute:
 $ bundle
 ```
 
-Finally, copy the extra files (refer to the [starter project][starter] for the detailed file directory structure) from the theme's gem to your Jekyll site, and append all the variables of the theme's `_config.yml` to your Jekyll site.
+Finally, copy the required files from the theme's gem (for detailed files, see [starter project][starter]) to your Jekyll site.
 
-> **Hint**: To locate the theme’s gem, execute:
+> **Hint**: To locate the installed theme’s gem, execute:
 >
 ```console
 $ bundle info --path jekyll-theme-chirpy
 ```
 
-Or you can [use the starter template][use-starter] to create a Jekyll site to save time copying contents from theme's gem.
+Or you can [**use the starter template**][use-starter] to create a Jekyll site to save time copying files from theme's gem. We have prepared everything for you there!
 
 ### Fork From GitHub
 
@@ -120,7 +121,7 @@ Update the variables of `_config.yml` as needed. Some of them are typical option
 - `url`
 - `avatar`
 - `timezone`
-- `theme_mode`
+- `lang`
 
 ### Running Local Server
 
@@ -153,12 +154,12 @@ For security reasons, GitHub Pages build runs on `safe` mode, which restricts us
 
 Quickly check the files needed for GitHub Actions build:
 
-1. Ensure your Jekyll site has the file `/.github/workflows/pages-deploy.yml`. Otherwise, create a new one and fill in the contents of the [workflow file][workflow], and the value of the `on.push.branches` should be the same as your repo's default branch name.
-2. Ensuer your Jekyll site has file `/tools/test.sh` and `/tools/deploy.sh`. Otherwise, copy them from this repo to your Jekyll site.
+- Ensure your Jekyll site has the file `.github/workflows/pages-deploy.yml`. Otherwise, create a new one and fill in the contents of the [workflow file][workflow], and the value of the `on.push.branches` should be the same as your repo's default branch name.
+- Ensuer your Jekyll site has file `tools/test.sh` and `tools/deploy.sh`. Otherwise, copy them from this repo to your Jekyll site.
 
-Next, rename your repoistory to `<GH-USERNAME>.github.io` on GitHub.
+And then rename your repoistory to `<GH-USERNAME>.github.io` on GitHub.
 
-And then publish your Jekyll site by:
+Now publish your Jekyll site by:
 
 1. Push any commit to remote to trigger the GitHub Actions workflow. Once the build is complete and successful, a new remote branch named `gh-pages` will appear to store the built site files.
 
@@ -218,5 +219,6 @@ This work is published under [MIT](https://github.com/cotes2020/jekyll-theme-chi
 
 [starter]: https://github.com/cotes2020/chirpy-starter
 [use-starter]: https://github.com/cotes2020/chirpy-starter/generate
-[workflow]:https://github.com/cotes2020/jekyll-theme-chirpy/blob/master/.github/workflows/pages-deploy.yml.hook
-[jb]:https://www.jetbrains.com/?from=jekyll-theme-chirpy
+[workflow]: https://github.com/cotes2020/jekyll-theme-chirpy/blob/master/.github/workflows/pages-deploy.yml.hook
+[jb]: https://www.jetbrains.com/?from=jekyll-theme-chirpy
+

data/_config.yml

@@ -1,5 +1,18 @@
 # The Site Configuration
 
+# Import the theme
+theme: jekyll-theme-chirpy
+
+# Only if your site type is GitHub Project sites and doesn't have a custom domain,
+# change below value to '/projectname'.
+baseurl: ''
+
+# the HTML language tag › https://www.w3.org/International/questions/qa-choosing-language-tags
+lang: en-US
+
+# Change to your timezone › http://www.timezoneconverter.com/cgi-bin/findzone/findzone
+timezone: Asia/Shanghai
+
 # jekyll-seo-tag settings › https://github.com/jekyll/jekyll-seo-tag/blob/master/docs/usage.md
 # --------------------------
 title: Chirpy                          # the main title
@@ -36,14 +49,6 @@ social:
 google_site_verification: google_meta_tag_verification # change to your verification string
 # --------------------------
 
-
-# Only if your site type is GitHub Project sites and doesn't have a custom domain,
-# change below value to '/projectname'.
-baseurl: ''
-
-# Change to your timezone › http://www.timezoneconverter.com/cgi-bin/findzone/findzone
-timezone: Asia/Shanghai
-
 google_analytics:
   id: ''          # Fill with your Google Analytics ID
   pv:
@@ -55,11 +60,6 @@ google_analytics:
     proxy_endpoint: ''
     cache: false  # pv data local cache, good for the users from GFW area.
 
-disqus:
-  comments: false  # boolean type, the global switch for posts comments.
-  shortname: ''    # Fill with your Disqus shortname. › https://help.disqus.com/en/articles/1717111-what-s-a-shortname
-
-
 # Prefer color scheme setting.
 #
 # Note: Keep empty will follow the system prefer color by default,
@@ -69,7 +69,6 @@ disqus:
 # Available options:
 #
 #     light  - Use the light color scheme
-#
 #     dark   - Use the dark color scheme
 #
 theme_mode:   # [light|dark]
@@ -87,8 +86,14 @@ avatar: https://cdn.jsdelivr.net/gh/cotes2020/chirpy-images/commons/avatar.jpg
 # boolean type, the global switch for ToC in posts.
 toc: true
 
+disqus:
+  comments: false  # boolean type, the global switch for posts comments.
+  shortname: ''    # Fill with your Disqus shortname. › https://help.disqus.com/en/articles/1717111-what-s-a-shortname
+
 paginate: 10
 
+# ------------ The following options are not recommended to be modified ------------------
+
 kramdown:
   syntax_highlighter: rouge
   syntax_highlighter_opts:   # Rouge Options › https://github.com/jneen/rouge#full-options
@@ -101,7 +106,7 @@ kramdown:
       start_line: 1
 
 # DO NOT change this unless you're a Pro user on Jekyll and Web development,
-# or you think you're smart enough to change other relevant URLs within this template.
+# Or you think you're smart enough to change other relevant URLs within this template.
 permalink: /posts/:title/
 
 collections:
@@ -119,55 +124,19 @@ defaults:
       layout: post
       comments: true    # Enable comments in posts.
       toc: true         # Display TOC column in posts.
-      breadcrumb:
-        -
-          label: Posts
-          url: /
   -
     scope:
       path: _drafts
     values:
       comments: false
-  -
-    scope:
-      path: index.html
-    values:
-      breadcrumb:
-        -
-          label: Posts
-  -
-    scope:
-      path: tags
-    values:
-      breadcrumb:
-        -
-          label: Home
-          url: /
-        -
-          label: Tags
-          url: /tabs/tags/
-  -
-    scope:
-      path: categories
-    values:
-      breadcrumb:
-        -
-          label: Home
-          url: /
-        -
-          label: Categories
-          url: /tabs/categories/
   -
     scope:
       path: ''
       type: tabs             # see `site.collections`
     values:
       layout: page
+      permalink: /:title/
       dynamic_title: true    # Hide title in mobile screens.
-      breadcrumb:
-        -
-          label: Home
-          url: /
 
 sass:
   style: compressed
@@ -183,8 +152,9 @@ compress_html:
 
 exclude:
   - vendor
-  - Gemfile.lock
   - Gemfile
+  - Gemfile.lock
+  - jekyll-theme-chirpy.gemspec
   - tools
   - docs
   - README.md

data/_includes/disqus.html

@@ -4,7 +4,7 @@
 -->
 
 <div id="disqus" class="pt-2 pb-2">
-  <p class="text-center text-muted pb-5">
+  <p class="text-center text-muted small pb-5">
     Loading comments from <a href="https://disqus.com/">Disqus</a> ...
   </p>
 </div>

data/_includes/post-nav.html

@@ -9,7 +9,8 @@
     <p>{{ page.previous.title }}</p>
   </a>
   {% else %}
-  <span class="btn btn-outline-primary disabled">
+  <span class="btn btn-outline-primary disabled"
+    prompt="{{ site.data.label.post.button.previous | default: 'previous' }}">
     <p>-</p>
   </span>
   {% endif %}
@@ -20,7 +21,8 @@
     <p>{{ page.next.title }}</p>
   </a>
   {% else %}
-  <span class="btn btn-outline-primary disabled">
+  <span class="btn btn-outline-primary disabled"
+    prompt="{{ site.data.label.post.button.next | default: 'next' }}">
     <p>-</p>
   </span>
   {% endif %}

data/_includes/topbar.html

@@ -5,21 +5,42 @@
 <div id="topbar-wrapper" class="row justify-content-center topbar-down">
   <div id="topbar" class="col-11 d-flex h-100 align-items-center justify-content-between">
     <span id="breadcrumb">
-      {% for item in page.breadcrumb %}
-        {% if item.url %}
+
+    {% assign paths = page.url | split: '/' %}
+
+    {% if paths.size == 0 %}
+      <!-- index page -->
+      <span>{{ 'Posts' }}</span>
+    {% else %}
+
+      {% for item in paths %}
+
+        {% if forloop.first %}
+          {% unless page.layout == 'post' %}
+          <span>
+            <a href="{{ '/' | relative_url }}">{{ 'Home' }}</a>
+          </span>
+          {% endunless %}
+
+        {% elsif forloop.last %}
+          <span>{{ page.title }}</span>
+
+        {% else %}
         <span>
-          <a href="{{ site.baseurl }}{{ item.url | remove: '.html'}}">
-            {{ item.label }}
+          {% assign url = item %}
+          {% if item == 'posts' and page.layout == 'post' %}
+            {% assign url = '/' %}
+          {% endif %}
+          <a href="{{ url | relative_url }}">
+            {{ item | capitalize }}
           </a>
         </span>
-        {% else %}
-          <span>{{ item.label }}</span>
+
         {% endif %}
+
       {% endfor %}
 
-      {% unless page.layout == "home" %}
-        <span>{{ page.title }}</span>
-      {% endunless %}
+    {% endif %}
 
     </span><!-- endof #breadcrumb -->
 

data/_layouts/default.html

@@ -11,7 +11,7 @@ layout: compress
   {% endif %}
 {% endcapture %}
 
-<html lang="{{ site.lang | split: "_" | first | default: "en" }}" {{ prefer_mode }}>
+<html lang="{{ site.lang | default: "en-US" }}" {{ prefer_mode }}>
 
   {% include head.html %}
 

data/_layouts/post.html

@@ -44,8 +44,8 @@ layout: default
 
       <div class="post-content">
 
-        {% if page.image %}
-          <img src="{{ page.image }}" class="preview-img" alt="Preview Image">
+        {% if page.image.src %}
+          <img src="{{ page.image.src }}" class="preview-img" alt="{{ page.image.alt | default: "Preview Image" }}">
         {% endif %}
 
         {{ content }}

data/_sass/jekyll-theme-chirpy.scss

@@ -1,7 +1,7 @@
 /*!
  * The styles for Jekyll theme Chirpy
  *
- * Chirpy v3.0.3 (https://github.com/cotes2020/jekyll-theme-chirpy)
+ * Chirpy v3.1.0 (https://github.com/cotes2020/jekyll-theme-chirpy)
  * © 2019 Cotes Chung
  * MIT Licensed
  */

data/_sass/layout/post.scss

@@ -44,7 +44,7 @@
     @include align-center;
 
     margin-top: 0;
-    margin-bottom: 2.5rem;
+    margin-bottom: 2.5rem !important;
   }
 }
 
@@ -85,6 +85,12 @@
     &.btn-outline-primary.disabled:focus {
       box-shadow: none;
     }
+    &::before {
+      color: var(--text-muted-color);
+      font-size: 0.65rem;
+      text-transform: uppercase;
+      content: attr(prompt);
+    }
   }
 
   p {
@@ -95,12 +101,6 @@
   }
 
   a {
-    &::before {
-      color: var(--text-muted-color);
-      font-size: 0.65rem;
-      text-transform: uppercase;
-      content: attr(prompt);
-    }
     &:first-child {
       border-top-right-radius: 0;
       border-bottom-right-radius: 0;
@@ -112,6 +112,7 @@
       right: 0.5px;
     }
   }
+
 } // .post-navigation
 
 @keyframes fade-up {

data/assets/js/dist/categories.min.js

@@ -1,5 +1,5 @@
 /*!
- * Chirpy v3.0.3 (https://github.com/cotes2020/jekyll-theme-chirpy/)
+ * Chirpy v3.1.0 (https://github.com/cotes2020/jekyll-theme-chirpy/)
  * © 2019 Cotes Chung
  * MIT Licensed
  */

data/assets/js/dist/home.min.js

@@ -1,5 +1,5 @@
 /*!
- * Chirpy v3.0.3 (https://github.com/cotes2020/jekyll-theme-chirpy/)
+ * Chirpy v3.1.0 (https://github.com/cotes2020/jekyll-theme-chirpy/)
  * © 2019 Cotes Chung
  * MIT Licensed
  */

data/assets/js/dist/page.min.js

@@ -1,5 +1,5 @@
 /*!
- * Chirpy v3.0.3 (https://github.com/cotes2020/jekyll-theme-chirpy/)
+ * Chirpy v3.1.0 (https://github.com/cotes2020/jekyll-theme-chirpy/)
  * © 2019 Cotes Chung
  * MIT Licensed
  */

data/assets/js/dist/post.min.js

@@ -1,5 +1,5 @@
 /*!
- * Chirpy v3.0.3 (https://github.com/cotes2020/jekyll-theme-chirpy/)
+ * Chirpy v3.1.0 (https://github.com/cotes2020/jekyll-theme-chirpy/)
  * © 2019 Cotes Chung
  * MIT Licensed
  */

data/assets/js/dist/pvreport.min.js

@@ -1,5 +1,5 @@
 /*!
- * Chirpy v3.0.3 (https://github.com/cotes2020/jekyll-theme-chirpy/)
+ * Chirpy v3.1.0 (https://github.com/cotes2020/jekyll-theme-chirpy/)
  * © 2019 Cotes Chung
  * MIT Licensed
  */

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-theme-chirpy
 version: !ruby/object:Gem::Version
-  version: 3.0.3
+  version: 3.1.0
 platform: ruby
 authors:
 - Cotes Chung
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-01-28 00:00:00.000000000 Z
+date: 2021-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll