Update critical file(s) according to Chirpy v6.2.3

.editorconfig

@@ -2,10 +2,18 @@ root = true
 
 [*]
 charset = utf-8
-# 2 space indentation
 indent_style = space
 indent_size = 2
 trim_trailing_whitespace = true
 # Unix-style newlines with a newline ending every file
 end_of_line = lf
 insert_final_newline = true
+
+[*.{js,css,scss}]
+quote_type = single
+
+[*.{yml,yaml}]
+quote_type = double
+
+[*.md]
+trim_trailing_whitespace = false

.github/workflows/pages-deploy.yml

@@ -1,53 +1,73 @@
-name: 'Automatic build'
+name: "Build and Deploy"
 on:
   push:
     branches:
       - main
+      - master
     paths-ignore:
       - .gitignore
       - README.md
       - LICENSE
 
-jobs:
+  # Allows you to run this workflow manually from the Actions tab
-  continuous-delivery:
+  workflow_dispatch:
 
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow one concurrent deployment
+concurrency:
+  group: "pages"
+  cancel-in-progress: true
+
+jobs:
+  build:
     runs-on: ubuntu-latest
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
         with:
-          fetch-depth: 0  # for posts's lastmod
+          fetch-depth: 0
+          # submodules: true
+          # If using the 'assets' git submodule from Chirpy Starter, uncomment above
+          # (See: https://github.com/cotes2020/chirpy-starter/tree/main/assets)
+
+      - name: Setup Pages
+        id: pages
+        uses: actions/configure-pages@v3
 
       - name: Setup Ruby
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 2.7
+          ruby-version: 3
           bundler-cache: true
 
-      - name: Check baseurl
+      - name: Build site
-        run: |
+        run: bundle exec jekyll b -d "_site${{ steps.pages.outputs.base_path }}"
-          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
+          JEKYLL_ENV: "production"
-        run: |
-          bundle exec jekyll b -d "_site$BASE_URL"
 
-      - name: Test Site
+      - name: Test site
         run: |
-          bash tools/test.sh
+          bundle exec htmlproofer _site \
+            \-\-disable-external=true \
+            \-\-ignore-urls "/^http:\/\/127.0.0.1/,/^http:\/\/0.0.0.0/,/^http:\/\/localhost/"
 
-      - name: Deploy
+      - name: Upload site artifact
-        run: |
+        uses: actions/upload-pages-artifact@v1
-          if [[ -n $BASE_URL ]]; then
+        with:
-            mv _site$BASE_URL _site-rename
+          path: "_site${{ steps.pages.outputs.base_path }}"
-            rm -rf _site
-            mv _site-rename _site
-          fi
 
-          bash tools/deploy.sh
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v2

.gitignore

@@ -1,15 +1,22 @@
-# hidden files
+# Bundler cache
-.*
+.bundle
-!.github
-
-# bundler cache
-_site
 vendor
 Gemfile.lock
 
-# rubygem
+# Jekyll cache
+.jekyll-cache
+_site
+
+# RubyGems
 *.gem
 
-# npm dependencies
+# NPM dependencies
 node_modules
 package-lock.json
+
+# IDE configurations
+.idea
+.vscode
+
+# Misc
+assets/js/dist

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "assets/lib"]
+	path = assets/lib
+	url = https://github.com/cotes2020/chirpy-static-assets.git

.nojekyll

@@ -0,0 +1 @@
+

Gemfile

@@ -1,22 +1,23 @@
+# frozen_string_literal: true
+
 source "https://rubygems.org"
 
-gem "jekyll-theme-chirpy", "~> 4.0", ">= 4.0.1"
+gem "jekyll-theme-chirpy", "~> 6.2", ">= 6.2.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"
+  gem "html-proofer", "~> 4.4"
 end
 
 # Windows and JRuby does not include zoneinfo files, so bundle the tzinfo-data gem
 # and associated library.
-install_if -> { RUBY_PLATFORM =~ %r!mingw|mswin|java! } do
+platforms :mingw, :x64_mingw, :mswin, :jruby do
-  gem "tzinfo", "~> 1.2"
+  gem "tzinfo", ">= 1", "< 3"
   gem "tzinfo-data"
 end
 
 # Performance-booster for watching directories on Windows
-gem "wdm", "~> 0.1.1", :install_if => Gem.win_platform?
+gem "wdm", "~> 0.1.1", :platforms => [:mingw, :x64_mingw, :mswin]
+
+# Lock `http_parser.rb` gem to `v0.6.x` on JRuby builds since newer versions of the gem
+# do not have a Java counterpart.
+gem "http_parser.rb", "~> 0.6.0", :platforms => [:jruby]

README.md

@@ -1,77 +1,49 @@
 # Chirpy Starter
 
-[![Gem Version](https://img.shields.io/gem/v/jekyll-theme-chirpy)](https://rubygems.org/gems/jekyll-theme-chirpy)
+[![Gem Version](https://img.shields.io/gem/v/jekyll-theme-chirpy)][gem] 
 [![GitHub license](https://img.shields.io/github/license/cotes2020/chirpy-starter.svg?color=blue)][mit]
 
-The startup template for [**Jekyll Theme Chirpy**][chirpy].
+When installing the [**Chirpy**][chirpy] theme through [RubyGems.org][gem], Jekyll can only read files in the folders
+`_data`, `_layouts`, `_includes`, `_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.
 
-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.
+The Jekyll team 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.
 
-The key files/directories to run/build the **Chirpy** theme are as follows:
+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:
 
 ```shell
 .
-├── _data
+├── _config.yml
 ├── _plugins
 ├── _tabs
-├── _config.yml
 └── index.html
 ```
 
-So we've extracted all the **Chirpy** gem necessary content here to help you get started quickly.
+To save you time, and also in case you lose some files while 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
+the basic environment. [Git](https://git-scm.com/) also needs to be installed.
 
 ## Installation
 
-[Use this template][usetemplate] to generate a new repository, and then execute:
+Sign in to GitHub and [**use this template**][use-template] to generate a brand new repository and name it
+`USERNAME.github.io`, where `USERNAME` represents your GitHub username.
 
-[usetemplate]: https://github.com/cotes2020/chirpy-starter/generate
+Then clone it to your local machine and run:
 
-```
+```console
 $ bundle
 ```
 
 ## Usage
 
-### Customing Stylesheet
+Please see the [theme's docs](https://github.com/cotes2020/jekyll-theme-chirpy#documentation).
-
-Creare a new file `/assets/css/style.scss` in your Jekyll site.
-
-And then add the following content:
-
-```scss
----
----
-
-@import {{ site.theme }}
-
-// add your style below
-```
-
-### Changing the Number of Tabs
-
-When adding or deleting files in the `_tabs` folder, you need to complete the section [Customing Stylesheet](#customing-stylesheet) first, and then add a new line before `@import`:
-
-```scss
-$tab-count: {{ site.tabs | size | plus: 1 }};
-```
-
-### Publishing to GitHub Pages
-
-See the [deployment instructions](https://github.com/cotes2020/jekyll-theme-chirpy#deployment) of `jekyll-theme-chirpy`.
-
-### Updating
-
-Please note that files and directories in this project may change as the [`jekyll-theme-chirpy`][chirpy] is updated. When updating, please ensure that the file directory structure of your Jekyll site is the same as that of this project.
-
-And then execute:
-
-```console
-$ bundle update jekyll-theme-chirpy
-```
-
-## Documentation
-
-See the [theme's docs](https://github.com/cotes2020/jekyll-theme-chirpy#documentation).
 
 ## License
 
@@ -79,4 +51,6 @@ 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,29 +3,27 @@
 # Import the theme
 theme: jekyll-theme-chirpy
 
-# Only if your site type is GitHub Project sites and doesn't have a custom domain,
+# The language of the webpage › http://www.lingoes.net/en/translator/langcode.htm
-# change below value to '/projectname'.
+# If it has the same name as one of the files in folder `_data/locales`, the layout language will also be changed,
-baseurl: ''
+# otherwise, the layout language will use the default value of 'en'.
+lang: en
 
-# the HTML language tag › https://www.w3.org/International/questions/qa-choosing-language-tags
+# Change to your timezone › https://kevinnovak.github.io/Time-Zone-Picker
-lang: en-US
+timezone:
-
-# 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
 
 tagline: A text-focused Jekyll theme # it will display as the sub-title
 
 description: >- # used by seo meta and the atom feed
-  A minimal, portfolio, sidebar,
+  A minimal, responsive and feature-rich Jekyll theme for technical writing.
-  bootstrap Jekyll theme with responsive web design
-  and focuses on text presentation.
 
-# fill in the protocol & hostname for your site, e.g., 'https://username.github.io'
+# Fill in the protocol & hostname for your site.
-url: ''
+# e.g. 'https://username.github.io', note that it does not end with a '/'.
+url: ""
 
 github:
   username: github_username # change to your github username
@@ -37,7 +35,7 @@ social:
   # Change to your full name.
   # It will be displayed as the default author of the posts and the copyright owner in the Footer
   name: your_full_name
-  email: example@doamin.com             # change to your email address
+  email: example@domain.com # change to your email address
   links:
     # The first element serves as the copyright owner's link
     - https://twitter.com/username # change to your twitter homepage
@@ -46,15 +44,13 @@ social:
     # - https://www.facebook.com/username
     # - https://www.linkedin.com/in/username
 
-google_site_verification: google_meta_tag_verification # change to your verification string
+google_site_verification: # fill in to your verification string
-# --------------------------
+
+# ↑ --------------------------
+# The end of `jekyll-seo-tag` settings
 
 google_analytics:
-  id: ''              # fill in your Google Analytics ID
+  id: # fill in your Google Analytics ID
-  # Google Analytics pageviews report settings
-  pv:
-    proxy_endpoint:   # fill in the Google Analytics superProxy endpoint of Google App Engine
-    cache_path:       # the local PV cache data, friendly to visitors from GFW region
 
 # Prefer color scheme setting.
 #
@@ -74,20 +70,50 @@ 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.
+# boolean type, the global switch for TOC in posts.
 toc: true
 
-disqus:
+comments:
-  comments: false  # boolean type, the global switch for posts comments.
+  active: # The global switch for posts comments, e.g., 'disqus'.  Keep it empty means disable
-  shortname: ''    # Fill with your Disqus shortname. › https://help.disqus.com/en/articles/1717111-what-s-a-shortname
+  # The active options are as follows:
+  disqus:
+    shortname: # fill with the Disqus shortname. › https://help.disqus.com/en/articles/1717111-what-s-a-shortname
+  # utterances settings › https://utteranc.es/
+  utterances:
+    repo: # <gh-username>/<repo>
+    issue_term: # < url | pathname | title | ...>
+  # Giscus options › https://giscus.app
+  giscus:
+    repo: # <gh-username>/<repo>
+    repo_id:
+    category:
+    category_id:
+    mapping: # optional, default to 'pathname'
+    input_position: # optional, default to 'bottom'
+    lang: # optional, default to the value of `site.lang`
+    reactions_enabled: # optional, default to the value of `1`
+
+# Self-hosted static assets, optional › https://github.com/cotes2020/chirpy-static-assets
+assets:
+  self_host:
+    enabled: # boolean, keep empty means false
+    # specify the Jekyll environment, empty means both
+    # only works if `assets.self_host.enabled` is 'true'
+    env: # [development|production]
+
+pwa:
+  enabled: true # the option for PWA feature
 
 paginate: 10
 
+# The base URL of your site
+baseurl: ""
+
 # ------------ The following options are not recommended to be modified ------------------
 
 kramdown:
@@ -106,11 +132,9 @@ collections:
     output: true
     sort_by: order
 
-
 defaults:
-  -
+  - scope:
-    scope:
+      path: "" # An empty string here means all files in the project
-      path: ''          # An empty string here means all files in the project
       type: posts
     values:
       layout: post
@@ -119,19 +143,24 @@ defaults:
       # DO NOT modify the following parameter unless you are confident enough
       # to update the code of all other post links in this project.
       permalink: /posts/:title/
-  -
+  - scope:
-    scope:
       path: _drafts
     values:
       comments: false
-  -
+  - scope:
-    scope:
+      path: ""
-      path: ''
       type: tabs # see `site.collections`
     values:
       layout: page
       permalink: /:title/
-      dynamic_title: true    # Hide title in mobile screens.
+  - scope:
+      path: assets/img/favicons
+    values:
+      swcache: true
+  - scope:
+      path: assets/js/dist
+    values:
+      swcache: true
 
 sass:
   style: compressed
@@ -146,15 +175,14 @@ compress_html:
     envs: [development]
 
 exclude:
-  - '*.gem'
+  - "*.gem"
-  - '*.gemspec'
+  - "*.gemspec"
-  - tools
   - docs
+  - tools
   - README.md
   - LICENSE
-  - gulpfile.js
+  - rollup.config.js
-  - node_modules
+  - package*.json
-  - '*.json'
 
 jekyll-archives:
   enabled: [categories, tags]

_data/contact.yml

@@ -1,30 +1,28 @@
 #  The contact options.
 
--
+- type: github
-  type: github
+  icon: "fab fa-github"
-  icon: 'fab fa-github-alt'
--
-  type: twitter
-  icon: 'fab fa-twitter'
--
-  type: email
-  icon: 'fas fa-envelope'
-  noblank: true            # open link in current tab
--
-  type: rss
-  icon: 'fas fa-rss'
-  noblank: true
 
+- type: twitter
+  icon: "fa-brands fa-x-twitter"
+
+- type: email
+  icon: "fas fa-envelope"
+  noblank: true # open link in current tab
+
+- type: rss
+  icon: "fas fa-rss"
+  noblank: true
 # Uncomment and complete the url below to enable more contact options
-# -
+#
-#   type: mastodon
+# - type: mastodon
 #   icon: 'fab fa-mastodon'   # icons powered by <https://fontawesome.com/>
-#   url:  ''                  # Fill with your mastodon account page
+#   url:  ''                  # Fill with your Mastodon account page, rel="me" will be applied for verification
-# -
+#
-#   type: linkedin
+# - type: linkedin
 #   icon: 'fab fa-linkedin'   # icons powered by <https://fontawesome.com/>
 #   url:  ''                  # Fill with your Linkedin homepage
-# -
+#
-#   type: stack-overflow
+# - type: stack-overflow
 #   icon: 'fab fa-stack-overflow'
 #   url:  ''                  # Fill with your stackoverflow homepage

_data/date_format.yml

@@ -1,7 +0,0 @@
-#  The date format
-
-tooltip: "%a, %b %e, %Y, %l:%M %p %z"
-
-post:
-  long: "%b %e, %Y"
-  short: "%b %e"

_data/label.yml

@@ -1,19 +0,0 @@
-# The label text of site.
-
-panel:
-  lastmod: Recent Update
-  trending_tags: Trending Tags
-  toc: Contents
-
-post:
-  relate_posts: Further Reading
-  share: Share
-  button:
-    next: Newer
-    previous: Older
-
-search_hint: Search   # text show on search bar
-
-pin_prompt: Pinned    # pinned prompt
-
-read_time_unit: min   # see posts' time to read

_data/rights.yml

@@ -1,11 +0,0 @@
-#  License data
-
-license:
-  name: CC BY 4.0
-  link: "https://creativecommons.org/licenses/by/4.0/"
-
-brief: Some rights reserved.
-
-verbose: >-
-  Except where otherwise noted, the blog posts on this site are licensed
-  under the Creative Commons Attribution 4.0 International (CC BY 4.0) License by the author.

_data/share.yml

@@ -2,26 +2,24 @@
 #  Icons from <https://fontawesome.com/>
 
 platforms:
-  -
+  - type: Twitter
-    type: Twitter
+    icon: "fa-brands fa-square-x-twitter"
-    icon: "fab fa-twitter"
     link: "https://twitter.com/intent/tweet?text=TITLE&url=URL"
-  -
+
-    type: Facebook
+  - type: Facebook
     icon: "fab fa-facebook-square"
     link: "https://www.facebook.com/sharer/sharer.php?title=TITLE&u=URL"
-  -
+
-    type: Telegram
+  - type: Telegram
     icon: "fab fa-telegram"
-    link: "https://telegram.me/share?text=TITLE&url=URL"
+    link: "https://t.me/share/url?url=URL&text=TITLE"
 
   # Uncomment below if you need to.
-  # -
+  #
-  #   type: Linkedin
+  # - type: Linkedin
   #   icon: "fab fa-linkedin"
   #   link: "https://www.linkedin.com/sharing/share-offsite/?url=URL"
   #
-  # -
+  # - type: Weibo
-  #   type: Weibo
   #   icon: "fab fa-weibo"
   #   link: "http://service.weibo.com/share/share.php?title=TITLE&url=URL"

_tabs/about.md

@@ -1,8 +1,8 @@
 ---
-title: About
+# the default layout is 'page'
-icon: fas fa-info
+icon: fas fa-info-circle
 order: 4
 ---
 
-
+> Add Markdown syntax content to file `_tabs/about.md`{: .filepath } and it will show up on this page.
-> **Note**: Add Markdown syntax content to file `_tabs/about.md` and it will show up on this page.
+{: .prompt-tip }

_tabs/archives.md

@@ -1,7 +1,5 @@
 ---
 layout: archives
-title: Archives
 icon: fas fa-archive
 order: 3
 ---
-

_tabs/categories.md

@@ -1,6 +1,5 @@
 ---
 layout: categories
-title: Categories
 icon: fas fa-stream
 order: 1
 ---

_tabs/tags.md

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

tools/deploy.sh

@@ -1,73 +0,0 @@
-#!/usr/bin/env bash
-#
-# Deploy the content of _site to 'origin/<pages_branch>'
-
-set -eu
-
-PAGES_BRANCH="gh-pages"
-
-_no_branch=false
-_backup_dir="$(mktemp -d)"
-
-init() {
-  if [[ -z ${GITHUB_ACTION+x} ]]; then
-    echo "ERROR: This script is not allowed to run outside of GitHub Action."
-    exit -1
-  fi
-
-  # Gemfile could be changed by `bundle install` in actions workflow
-  if [[ -n $(git ls-files | grep Gemfile.lock) && -n \
-  $(git status Gemfile.lock --porcelain) ]]; then
-    git checkout -- Gemfile.lock
-  fi
-
-  if [[ -z $(git branch -av | grep "$PAGES_BRANCH") ]]; then
-    _no_branch=true
-    git checkout -b "$PAGES_BRANCH"
-  else
-    git checkout "$PAGES_BRANCH"
-  fi
-}
-
-backup() {
-  mv _site/* "$_backup_dir"
-  mv .git "$_backup_dir"
-
-  # When adding custom domain from Github website,
-  # the CANME only exist on `gh-pages` branch
-  if [[ -f CNAME ]]; then
-    mv CNAME "$_backup_dir"
-  fi
-}
-
-flush() {
-  rm -rf ./*
-  rm -rf .[^.] .??*
-
-  shopt -s dotglob nullglob
-  mv "$_backup_dir"/* .
-}
-
-deploy() {
-  git config --global user.name "GitHub Actions"
-  git config --global user.email "41898282+github-actions[bot]@users.noreply.github.com"
-
-  git update-ref -d HEAD
-  git add -A
-  git commit -m "[Automation] Site update No.${GITHUB_RUN_NUMBER}"
-
-  if $_no_branch; then
-    git push -u origin "$PAGES_BRANCH"
-  else
-    git push -f
-  fi
-}
-
-main() {
-  init
-  backup
-  flush
-  deploy
-}
-
-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