Update critical file(s) according to Chirpy v4.3.3

.github/workflows/pages-deploy.yml

@@ -25,29 +25,5 @@ jobs:
           ruby-version: 2.7
           bundler-cache: true
 
-      - name: Check baseurl
-        run: |
-          baseurl="$(grep '^baseurl:' _config.yml | sed "s/.*: *//;s/['\"]//g;s/#.*//")"
-          if [[ -n $baseurl ]]; then
-            echo "BASE_URL=$baseurl" >> $GITHUB_ENV
-          fi
-
-      - name: Build Site
-        env:
-          JEKYLL_ENV: production
-        run: |
-          bundle exec jekyll b -d "_site$BASE_URL"
-
-      - name: Test Site
-        run: |
-          bash tools/test.sh
-
       - name: Deploy
-        run: |
+        run: bash tools/deploy.sh
-          if [[ -n $BASE_URL ]]; then
-            mv _site$BASE_URL _site-rename
-            rm -rf _site
-            mv _site-rename _site
-          fi
-
-          bash tools/deploy.sh

.gitignore

@@ -3,11 +3,11 @@
 !.git*
 !.editorconfig
 !.nojekyll
+!.travis.yml
 
 # bundler cache
 _site
 vendor
-Gemfile.lock
 
 # rubygem
 *.gem

.nojekyll

@@ -0,0 +1 @@
+

Gemfile

@@ -1,11 +1,8 @@
+# frozen_string_literal: true
+
 source "https://rubygems.org"
 
-gem "jekyll-theme-chirpy", "~> 4.2", ">= 4.2.0"
+gem "jekyll-theme-chirpy", "~> 4.3", ">= 4.3.3"
-
-group :jekyll_plugins do
-  # If you have any plugins, put them here!
-  # gem "jekyll-xxx", "~> x.y"
-end
 
 group :test do
   gem "html-proofer", "~> 3.18"
@@ -20,3 +17,6 @@ end
 
 # Performance-booster for watching directories on Windows
 gem "wdm", "~> 0.1.1", :install_if => Gem.win_platform?
+
+# Jekyll <= 4.2.0 compatibility with Ruby 3.0
+gem "webrick", "~> 1.7"

README.md

@@ -1,28 +1,31 @@
 # Chirpy Starter [![Gem Version](https://img.shields.io/gem/v/jekyll-theme-chirpy)](https://rubygems.org/gems/jekyll-theme-chirpy) [![GitHub license](https://img.shields.io/github/license/cotes2020/chirpy-starter.svg?color=blue)][mit]
 
+When installing the [**Chirpy**][chirpy] theme through [RubyGems.org][gem], Jekyll can only read files in the folders `_includes`, `_layout`, `_sass` and `assets`, as well as a small part of options of the `_config.yml` file from the theme's gem. If you have ever installed this theme gem, you can use the command `bundle info --path jekyll-theme-chirpy` to locate these files.
 
-The startup template for [**Jekyll Theme Chirpy**][chirpy].
+The Jekyll organization claims that this is to leave the ball in the user’s court, but this also results in users not being able to enjoy the out-of-the-box experience when using feature-rich themes.
 
-When installing the **Chirpy** theme through [RubyGems][gem], Jekyll can only read files in the folders `_includes`, `_layout`, `_sass` and `assets`, as well as a small part of options of the `_config.yml` file from the theme's gem. (You can find the gem files by using the command `bundle info --path jekyll-theme-chirpy`). To fully use all the features of **Chirpy**, you need to copy the other critical files/directories from the theme's gem to your Jekyll site.
+To fully use all the features of **Chirpy**, you need to copy the other critical files from the theme's gem to your Jekyll site. The following is a list of targets:
-
-The critical files/directories to run or build the **Chirpy** theme are as follows:
 
 ```shell
 .
+├── _config.yml
 ├── _data
 ├── _plugins
 ├── _tabs
-├── _config.yml
+└── index.html
-└──  index.html
 ```
 
-So we've extracted all the **Chirpy** gem necessary content here to help you get started quickly.
+In order to save your time, and to prevent you from missing some files when copying, we extract those files/configurations of the latest version of the **Chirpy** theme and the [CD][CD] workflow to here, so that you can start writing in minutes.
+
+## Prerequisites
+
+Follow the instructions in the [Jekyll Docs](https://jekyllrb.com/docs/installation/) to complete the installation of `Ruby`, `RubyGems`, `Jekyll` and `Bundler`.
 
 ## Installation
 
-[Use this template][usetemplate] to generate a new repository, and then execute:
+[**Use this template**][use-template] to generate a brand new repository and name it `<GH_USERNAME>.github.io`, where `GH_USERNAME` represents your GitHub username.
 
-[usetemplate]: https://github.com/cotes2020/chirpy-starter/generate
+Then clone it to your local machine and run:
 
 ```
 $ bundle
@@ -32,22 +35,12 @@ $ bundle
 
 Please see the [theme's docs](https://github.com/cotes2020/jekyll-theme-chirpy#usage).
 
-## Upgrading
-
-First, please modify the target version number of `jekyll-theme-chirpy` in the `Gemfile` (e.g., `gem "jekyll-theme-chirpy", "~> 4.0", ">= 4.0.1"`).
-
-After that, execute the following command:
-
-```console
-$ bundle update jekyll-theme-chirpy
-```
-
-As the version upgrades, the critical files and configuration options will change. Please refer to the [Upgrade Guide](https://github.com/cotes2020/jekyll-theme-chirpy/wiki/Upgrade-Guide) to keep your website files in sync with the latest version of the theme.
-
 ## License
 
 This work is published under [MIT][mit] License.
 
 [gem]: https://rubygems.org/gems/jekyll-theme-chirpy
 [chirpy]: https://github.com/cotes2020/jekyll-theme-chirpy/
+[use-template]: https://github.com/cotes2020/chirpy-starter/generate
+[CD]: https://en.wikipedia.org/wiki/Continuous_deployment
 [mit]: https://github.com/cotes2020/chirpy-starter/blob/master/LICENSE

_config.yml

@@ -3,8 +3,8 @@
 # Import the theme
 theme: jekyll-theme-chirpy
 
-# Only if your site type is GitHub Project sites and doesn't have a custom domain,
+# Change the following value to '/PROJECT_NAME' ONLY IF your site type is GitHub Pages Project sites
-# change below value to '/projectname'.
+# and doesn't have a custom domain.
 baseurl: ''
 
 # The language of the webpage › http://www.lingoes.net/en/translator/langcode.htm
@@ -79,10 +79,10 @@ theme_mode:   # [light|dark]
 # will be added to all image (site avatar & posts' images) paths starting with '/'
 #
 # e.g. 'https://cdn.com'
-img_cdn: ''
+img_cdn:
 
 # the avatar on sidebar, support local or CORS resources
-avatar: https://cdn.jsdelivr.net/gh/cotes2020/chirpy-images/commons/avatar.jpg
+avatar:
 
 # boolean type, the global switch for ToC in posts.
 toc: true
@@ -159,7 +159,7 @@ exclude:
   - LICENSE
   - gulpfile.js
   - node_modules
-  - '*.json'
+  - package.json
 
 jekyll-archives:
   enabled: [categories, tags]

_data/contact.yml

@@ -2,7 +2,7 @@
 
 -
   type: github
-  icon: 'fab fa-github-alt'
+  icon: 'fab fa-github'
 -
   type: twitter
   icon: 'fab fa-twitter'

_data/locales/en.yml

@@ -76,7 +76,11 @@ post:
   button:
     next: Newer
     previous: Older
-    copy: Copied!
+    copy_code:
+      succeed: Copied!
+    share_link:
+      title: Copy link
+      succeed: Link copied successfully!
   # pinned prompt of posts list on homepage
   pin_prompt: Pinned
 

_data/locales/id-ID.yml

@@ -76,7 +76,11 @@ post:
   button:
     next: Terbaru
     previous: Terlama
-    copy: Disalin!
+    copy_code:
+      succeed: Disalin!
+    share_link:
+      title: Salin tautan
+      succeed: Tautan berhasil disalin!
   # pinned prompt of posts list on homepage
   pin_prompt: Disematkan
 

_data/locales/zh-CN.yml

@@ -75,7 +75,11 @@ post:
   button:
     next: 下一篇
     previous: 上一篇
-    copy: 已复制！
+    copy_code:
+      succeed: 已复制！
+    share_link:
+      title:  分享链接
+      succeed: 链接已复制！
   # pinned prompt of posts list on homepage
   pin_prompt: 顶置
 

_tabs/about.md

@@ -1,6 +1,6 @@
 ---
 title: About
-icon: fas fa-info
+icon: fas fa-info-circle
 order: 4
 ---
 

_tabs/tags.md

@@ -1,6 +1,6 @@
 ---
 layout: tags
 title: Tags
-icon: fas fa-tags
+icon: fas fa-tag
 order: 2
 ---

tools/deploy.sh

@@ -1,28 +1,80 @@
 #!/usr/bin/env bash
 #
-# Deploy the content of _site to 'origin/<pages_branch>'
+# Build, test and then deploy the site content to 'origin/<pages_branch>'
+#
+# Requirement: html-proofer, jekyll
+#
+# Usage: See help information
 
 set -eu
 
 PAGES_BRANCH="gh-pages"
 
-_no_branch=false
+SITE_DIR="_site"
+
+_opt_dry_run=false
+
+_config="_config.yml"
+
+_no_pages_branch=false
+
 _backup_dir="$(mktemp -d)"
 
+_baseurl=""
+
+help() {
+  echo "Build, test and then deploy the site content to 'origin/<pages_branch>'"
+  echo
+  echo "Usage:"
+  echo
+  echo "   bash ./tools/deploy.sh [options]"
+  echo
+  echo "Options:"
+  echo '     -c, --config   "<config_a[,config_b[...]]>"    Specify config file(s)'
+  echo "     --dry-run                Build site and test, but not deploy"
+  echo "     -h, --help               Print this information."
+}
+
 init() {
-  if [[ -z ${GITHUB_ACTION+x} ]]; then
+  if [[ -z ${GITHUB_ACTION+x} && $_opt_dry_run == 'false' ]]; then
-    echo "ERROR: This script is not allowed to run outside of GitHub Action."
+    echo "ERROR: It is not allowed to deploy outside of the GitHub Action envrionment."
+    echo "Type option '-h' to see the help information."
     exit -1
   fi
 
-  # Gemfile could be changed by `bundle install` in actions workflow
+  _baseurl="$(grep '^baseurl:' _config.yml | sed "s/.*: *//;s/['\"]//g;s/#.*//")"
-  if [[ -n $(git ls-files | grep Gemfile.lock) && -n \
+}
-  $(git status Gemfile.lock --porcelain) ]]; then
+
-    git checkout -- Gemfile.lock
+build() {
+  # clean up
+  if [[ -d $SITE_DIR ]]; then
+    rm -rf "$SITE_DIR"
   fi
 
+  # build
+  JEKYLL_ENV=production bundle exec jekyll b -d "$SITE_DIR$_baseurl" --config "$_config"
+}
+
+test() {
+  bundle exec htmlproofer \
+    --disable-external \
+    --check-html \
+    --allow_hash_href \
+    "$SITE_DIR"
+}
+
+resume_site_dir() {
+  if [[ -n $_baseurl ]]; then
+    # Move the site file to the regular directory '_site'
+    mv "$SITE_DIR$_baseurl" "${SITE_DIR}-rename"
+    rm -rf "$SITE_DIR"
+    mv "${SITE_DIR}-rename" "$SITE_DIR"
+  fi
+}
+
+setup_gh() {
   if [[ -z $(git branch -av | grep "$PAGES_BRANCH") ]]; then
-    _no_branch=true
+    _no_pages_branch=true
     git checkout -b "$PAGES_BRANCH"
   else
     git checkout "$PAGES_BRANCH"
@@ -30,7 +82,7 @@ init() {
 }
 
 backup() {
-  mv _site/* "$_backup_dir"
+  mv "$SITE_DIR"/* "$_backup_dir"
   mv .git "$_backup_dir"
 
   # When adding custom domain from Github website,
@@ -56,7 +108,7 @@ deploy() {
   git add -A
   git commit -m "[Automation] Site update No.${GITHUB_RUN_NUMBER}"
 
-  if $_no_branch; then
+  if $_no_pages_branch; then
     git push -u origin "$PAGES_BRANCH"
   else
     git push -f
@@ -65,9 +117,43 @@ deploy() {
 
 main() {
   init
+  build
+  test
+  resume_site_dir
+
+  if $_opt_dry_run; then
+    exit 0
+  fi
+
+  setup_gh
   backup
   flush
   deploy
 }
 
+while (($#)); do
+  opt="$1"
+  case $opt in
+    -c | --config)
+      _config="$2"
+      shift
+      shift
+      ;;
+    --dry-run)
+      # build & test, but not deploy
+      _opt_dry_run=true
+      shift
+      ;;
+    -h | --help)
+      help
+      exit 0
+      ;;
+    *)
+      # unknown option
+      help
+      exit 1
+      ;;
+  esac
+done
+
 main

tools/test.sh

@@ -1,67 +0,0 @@
-#!/usr/bin/env bash
-#
-# Using HTML-proofer to test site.
-#
-# Requirement: https://github.com/gjtorikian/html-proofer
-#
-# Usage: bash /path/to/test.sh [indicated path]
-
-DEST=_site
-URL_IGNORE=cdn.jsdelivr.net
-
-_build=false
-
-help() {
-  echo "Usage:"
-  echo
-  echo "   bash ./tools/test.sh [options]"
-  echo
-  echo "Options:"
-  echo "     --build                  Run Jekyll build before test."
-  echo "     -d, --dir   <path>       Specify the test path."
-  echo "     -h, --help               Print this information."
-}
-
-if [[ -n $1 && -d $1 ]]; then
-  DEST=$1
-fi
-
-while (($#)); do
-  opt="$1"
-  case $opt in
-    --build)
-      _build=true
-      shift
-      ;;
-    -d | --dir)
-      if [[ ! -d $2 ]]; then
-        echo -e "Error: path '$2' doesn't exist\n"
-        help
-        exit 1
-      fi
-      DEST=$2
-      shift
-      shift
-      ;;
-    -h | --help)
-      help
-      exit 0
-      ;;
-    *)
-      # unknown option
-      help
-      exit 1
-      ;;
-  esac
-done
-
-if $_build; then
-  JEKYLL_ENV=production bundle exec jekyll b
-fi
-
-bundle exec htmlproofer "$DEST" \
-  --disable-external \
-  --check-html \
-  --empty_alt_ignore \
-  --allow_hash_href \
-  --url_ignore $URL_IGNORE