jekyll-theme-chirpy 3.0.1 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ecd06628a10c9eb5d0dee7c918bc289f49da6755d530812676072a9ca28abbf6
-  data.tar.gz: '0670685262ea8556adf3054ece889396100b85d7a967bd45f3218b9e84f5bf89'
+  metadata.gz: 7dae357242a626863cb40c464e20b5b09326e824c9f58e99a25ad7358ff4df4e
+  data.tar.gz: cd37d4fac2b8493c00c27e15cbf50925a250c05518b371dba106e1216fdb3e0f
 SHA512:
-  metadata.gz: a90a2ea6d74c88cc2c2a066d25c3987ca54535fa9a26b2157de81fb521dbe0490583af4584003a2cfbab0f2d7a12219eeded96fb5555d23788bdf64cb9654649
-  data.tar.gz: 52fc86fd2307e5ff592c00eb6540f6db987385b14da13b90e12101aee6cea7145ec92b850c960122ee5dc1988b2c05c5c8235985460b23623ccfc9f705ac457a
+  metadata.gz: d9f9edaaf304c366b54536a447304bcb9ad819dc9c24b8200eb80a13510d95d86d97fd394b1cc1c259a5a8c4526791c03a5c78d796d57916041b0c098077e4b4
+  data.tar.gz: 05a687f44cdf926927e216bdb3130709200a4a3ce1e43fac8ff2a765213cbc503238852e3073c18da7783495ef7aceafa68cfdf25f14dd44c341ea6b0886af89

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,6 +2,7 @@
 
 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)
@@ -14,12 +15,13 @@ A minimal, sidebar, responsive web design Jekyll theme that focuses on text pres
 ## Table of Contents
 
 - [Features](#features)
-- [Installation](#installation)
 - [Prerequisites](#prerequisites)
+- [Installation](#installation)
 - [Usage](#usage)
+- [Documentation](#documentation)
 - [Contributing](#contributing)
 - [Credits](#credits)
-- [Supporting](#supporting)
+- [Support](#support)
 - [License](#license)
 
 ## Features
@@ -40,7 +42,6 @@ A minimal, sidebar, responsive web design Jekyll theme that focuses on text pres
 - GA Pageviews reporting (Advanced)
 - SEO and Performance Optimization
 
-
 ## Prerequisites
 
 Follow the [Jekyll Docs](https://jekyllrb.com/docs/installation/) to complete the installation of `Ruby`, `RubyGems`, `Jekyll` and `Bundler`.
@@ -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 update, isolate irrelevant project files so you can focus on writing.
+- **Fork on GitHub** - Convenient for custom development, but difficult to update, only suitable for web developers.
 
-### Install From Rubygems
+### Installing the Theme Gem
 
 Add this line to your Jekyll site's `Gemfile`:
 
@@ -72,22 +73,19 @@ And then execute:
 $ bundle
 ```
 
-Finally, copy the missing 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.
+> ```console
+> $ bundle info --path jekyll-theme-chirpy
+> ```
 
-[starter]: https://github.com/cotes2020/chirpy-starter
-[use-starter]: https://github.com/cotes2020/chirpy-starter/generate
+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
+### Fork on GitHub
 
-[Fork **Chirpy**](https://github.com/cotes2020/jekyll-theme-chirpy/fork) from GitHub and clone your fork to local.
+[Fork **Chirpy**](https://github.com/cotes2020/jekyll-theme-chirpy/fork) on GitHub and then clone your fork to local. (Please note that the default branch code is in development.  If you want the blog to be stable, please switch to the [latest tag](https://github.com/cotes2020/jekyll-theme-chirpy/tags) and start writing.)
 
 Install gem dependencies by:
 
@@ -105,15 +103,14 @@ $ bash tools/init.sh
 
 What it does is:
 
-  1. Remove some files or directories from your repository:
+1. Remove some files or directories from your repository:
+    - `.travis.yml`
+    - files under `_posts`
+    - folder `docs`
 
-      - `.travis.yml`
-      - files under `_posts`
-      - folder `docs`
+2. If you use the `--no-gh` option, the directory `.github` will be deleted. Otherwise, setup the GitHub Action workflow by removing extension `.hook` of `.github/workflows/pages-deploy.yml.hook`, and then remove the other files and directories in folder `.github`.
 
-  2. If you use the `--no-gh` option, the directory `.github` will be deleted. Otherwise, setup the GitHub Action workflow by removing extension `.hook` of `.github/workflows/pages-deploy.yml.hook`, and then remove the other files and directories in folder `.github`.
-
-  3. Automatically create a commit to save the changes.
+3. Automatically create a commit to save the changes.
 
 ## Usage
 
@@ -121,10 +118,10 @@ What it does is:
 
 Update the variables of `_config.yml` as needed. Some of them are typical options:
 
-  - `url`
-  - `avatar`
-  - `timezone`
-  - `theme_mode`
+- `url`
+- `avatar`
+- `timezone`
+- `lang`
 
 ### Running Local Server
 
@@ -149,28 +146,28 @@ Open a browser and visit to _<http://localhost:4000>_.
 
 Before the deployment begins, checkout the file `_config.yml` and make sure the `url` is configured correctly. Furthermore, if you prefer the [**project site**](https://help.github.com/en/github/working-with-github-pages/about-github-pages#types-of-github-pages-sites) and don't use a custom domain, or you want to visit your website with a base url on a web server other than **GitHub Pages**, remember to change the `baseurl` to your project name that starting with a slash, e.g, `/project-name`.
 
-Now you can now choose ONE of the following methods to deploy your website.
+Now you can choose ONE of the following methods to deploy your Jekyll site.
 
 #### Deploy on GitHub Pages
 
 For security reasons, GitHub Pages build runs on `safe` mode, which restricts us from using plugins to generate additional page files. Therefore, we can use **GitHub Actions** to build the site, store the built site files on a new branch, and use that branch as the source of the GH Pages service.
 
-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.
+Quickly check the files needed for GitHub Actions build:
 
-[workflow]:https://github.com/cotes2020/jekyll-theme-chirpy/blob/master/.github/workflows/pages-deploy.yml.hook
+- 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.
 
-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 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.
+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.
 
-  2. Browse to your repo's landing page on GitHub and select the branch `gh-pages` as the [publishing source](https://docs.github.com/en/github/working-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site) throught _Settings_ → _Options_ → _GitHub Pages_:
+2. Browse to your repo's landing page on GitHub and select the branch `gh-pages` as the [publishing source](https://docs.github.com/en/github/working-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site) throught _Settings_ → _Options_ → _GitHub Pages_:
 
-      ![gh-pages-sources](https://cdn.jsdelivr.net/gh/cotes2020/chirpy-images/posts/20190809/gh-pages-sources.png)
+    ![gh-pages-sources](https://cdn.jsdelivr.net/gh/cotes2020/chirpy-images/posts/20190809/gh-pages-sources.png)
 
-  3. Visit your website at the address indicated by GitHub.
+3. Visit your website at the address indicated by GitHub.
 
 #### Deploy on Other Platforms
 
@@ -208,16 +205,28 @@ This theme is mainly built with [Jekyll](https://jekyllrb.com/) ecosystem, [Boot
 
 :tada: Thanks to all the volunteers who contributed to this project, their GitHub IDs are on [this list](https://github.com/cotes2020/jekyll-theme-chirpy/graphs/contributors). Also, I won't forget those guys who submitted the issues or unmerged PR because they reported bugs, shared ideas or inspired me to write more readable documentation.
 
-Also, thank [JetBrains][JB] for providing the open source license.
+Also, thank [JetBrains][jb] for providing the open source license.
 
-[![JB-logo](https://cdn.jsdelivr.net/gh/cotes2020/chirpy-images/commons/jetbrains.svg)][JB]
+[![JB-logo](https://cdn.jsdelivr.net/gh/cotes2020/chirpy-images/commons/jetbrains.svg)][jb]
 
-[JB]:https://www.jetbrains.com/?from=jekyll-theme-chirpy
+## Support
 
-## Supporting
+If you like this theme or find it helpful, please consider sponsoring me, because it will encourage and help me better maintain the project, I will be very grateful!
 
-If you enjoy this theme or find it helpful, please consider becoming my sponsor, I'd really appreciate it! Click the button <kbd>:heart: Sponsor</kbd> at the top of the [Home Page](https://github.com/cotes2020/jekyll-theme-chirpy) and choose a link that suits you to donate; this will encourage and help me better maintain the project.
+[![Buy Me a Coffee](https://img.shields.io/badge/Buy%20Me%20a%20Coffee-orange?logo=buy-me-a-coffee&logoColor=white)](https://www.buymeacoffee.com/coteschung)
+[![Wechat Pay](https://img.shields.io/badge/WeChat%20Pay-brightgreen?logo=wechat&logoColor=white)][cn-donation]
+[![Alipay](https://img.shields.io/badge/Alipay-blue?logo=alipay&logoColor=white)][cn-donation]
 
 ## License
 
 This work is published under [MIT](https://github.com/cotes2020/jekyll-theme-chirpy/blob/master/LICENSE) License.
+
+[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
+
+<!-- ReadMe links -->
+
+[jb]: https://www.jetbrains.com/?from=jekyll-theme-chirpy
+[cn-donation]: https://cotes.gitee.io/alipay-wechat-donation/
+

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,10 @@ compress_html:
 
 exclude:
   - vendor
-  - Gemfile.lock
   - Gemfile
+  - Gemfile.lock
+  - '*.gem'
+  - '*.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/footer.html

@@ -20,7 +20,8 @@
         Powered by
         <a href="https://jekyllrb.com" target="_blank" rel="noopener">Jekyll</a>
         with
-        <a href="{{ site.data.meta.homepage }}" target="_blank" rel="noopener">{{ site.data.meta.name }}</a>
+        <a href="https://github.com/cotes2020/jekyll-theme-chirpy"
+          target="_blank" rel="noopener">Chirpy</a>
         theme.
       </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/search-loader.html

@@ -1,13 +1,14 @@
 <!--
   Jekyll Simple Search loader
+  See: <https://github.com/christian-fei/Simple-Jekyll-Search>
 -->
 
 {% capture result_elem %}
 <div class="pl-1 pr-1 pl-sm-2 pr-sm-2 pl-lg-4 pr-lg-4 pl-xl-0 pr-xl-0">
   <a href="{{ site.url }}{url}">{title}</a>
   <div class="post-meta d-flex flex-column flex-sm-row text-muted mt-1 mb-1">
-    <div class="mr-sm-4"><i class="far fa-folder fa-fw"></i>{categories}</div>
-    <div><i class="fa fa-tag fa-fw"></i>{tags}</div>
+    {categories}
+    {tags}
   </div>
   <p>{snippet}</p>
 </div>
@@ -23,6 +24,23 @@ SimpleJekyllSearch({
   resultsContainer: document.getElementById('search-results'),
   json: '{{ '/assets/js/data/search.json' | relative_url }}',
   searchResultTemplate: '{{ result_elem | strip_newlines }}',
-  noResultsText: '{{ not_found }}'
+  noResultsText: '{{ not_found }}',
+  templateMiddleware: function(prop, value, template) {
+    if (prop === 'categories') {
+      if (value === '') {
+        return `${value}`;
+      } else {
+        return `<div class="mr-sm-4"><i class="far fa-folder fa-fw"></i>${value}</div>`;
+      }
+    }
+
+    if (prop === 'tags') {
+      if (value === '') {
+        return `${value}`;
+      } else {
+        return `<div><i class="fa fa-tag fa-fw"></i>${value}</div>`;
+      }
+    }
+  }
 });
 </script>

data/_includes/search-results.html

@@ -2,7 +2,7 @@
   The Search results
 -->
 <div id="search-result-wrapper" class="d-flex justify-content-center unloaded">
-  <div class="col-12 col-xl-11 post-content">
+  <div class="col-12 col-sm-11 post-content">
     <div id="search-hints">
       <h4 class="text-muted mb-4">{{ site.data.label.panel.trending_tags | default: 'Trending Tags' }}</h4>