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

.github/workflows/pages-deploy.yml

@@ -13,9 +13,6 @@ jobs:
 
     runs-on: ubuntu-latest
 
-    env:
-      GEMS_PATH: ~/vendor/bundle
-
     steps:
       - name: Checkout
         uses: actions/checkout@v2
@@ -23,22 +20,10 @@ jobs:
           fetch-depth: 0  # for posts's lastmod
 
       - name: Setup Ruby
-        uses: actions/setup-ruby@v1
+        uses: ruby/setup-ruby@v1
         with:
           ruby-version: 2.7
-
+          bundler-cache: true
-      - name: Bundle Caching
-        uses: actions/cache@v2
-        with:
-          path: ${{ env.GEMS_PATH }}
-          key: ${{ runner.os }}-gems-${{ hashFiles('**/Gemfile.lock') }}
-          restore-keys: |
-            ${{ runner.os }}-gems-
-
-      - name: Bundle Install
-        run: |
-          bundle config path ${{ env.GEMS_PATH }}
-          bundle install --jobs 4 --retry 3
 
       - name: Check baseurl
         run: |

.gitignore

@@ -1,10 +1,13 @@
 # hidden files
 .*
-!.github
+!.git*
+!.editorconfig
+!.nojekyll
 
-# jekyll cache
+# bundler cache
 _site
 vendor
+Gemfile.lock
 
 # rubygem
 *.gem

404.html

@@ -1,21 +0,0 @@
----
-layout: page
-title: "404: Page not found"
-permalink: /404.html
-
-redirect_from:
-  - /norobots/
-  - /assets/
-  - /posts/
-
-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="{{ '/' | 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>

Gemfile

@@ -1,9 +1,9 @@
 source "https://rubygems.org"
 
-gem "jekyll-theme-chirpy"
+gem "jekyll-theme-chirpy", "~> 4.1", ">= 4.1.0"
 
-# If you have any plugins, put them here!
 group :jekyll_plugins do
+  # If you have any plugins, put them here!
   # gem "jekyll-xxx", "~> x.y"
 end
 
@@ -18,5 +18,5 @@ install_if -> { RUBY_PLATFORM =~ %r!mingw|mswin|java! } do
   gem "tzinfo-data"
 end
 
-# # # Performance-booster for watching directories on Windows
+# Performance-booster for watching directories on Windows
 gem "wdm", "~> 0.1.1", :install_if => Gem.win_platform?

README.md

@@ -1,23 +1,23 @@
-# Chirpy Starter
+# 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]
+
 
 The startup template for [**Jekyll Theme Chirpy**][chirpy].
 
-When installing the Chirpy 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 (use the command `bundle info --path jekyll-theme-chirpy` to locate). To fully use all the features of Chirpy, you also need to copy other files/directories and config options from the theme's gem to your Jekyll site. So we extract all the required things of the theme's gem to help you quickly use Chirpy.
+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 critical files/directories to run or build the **Chirpy** theme are as follows:
 
 ```shell
-# The critical files/directories to run Chirpy theme
+.
 ├── _data
 ├── _plugins
 ├── _tabs
 ├── _config.yml
-├── app.js
+└──  index.html
-├── feed.xml
-├── index.html
-├── robots.txt
-├── sw.js
-└── 404.html
 ```
 
+So we've extracted all the **Chirpy** gem necessary content here to help you get started quickly.
+
 ## Installation
 
 [Use this template][usetemplate] to generate a new repository, and then execute:
@@ -30,50 +30,24 @@ $ bundle
 
 ## Usage
 
-### Customing Stylesheet
+Please see the [theme's docs](https://github.com/cotes2020/jekyll-theme-chirpy#usage).
 
-Creare a new file `/assets/css/style.scss` in your Jekyll site.
+## Upgrading
 
-And then add the following content:
+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"`).
 
-```scss
+After that, execute the following command:
----
----
-
-@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 `jekyll-theme-chirpy`'s [deployment instructions](https://github.com/cotes2020/jekyll-theme-chirpy#deployment). Note that in order to use GitHub Actions caching to speed up the deployment, you should add the `Gemfile.lock` file to your repository.
-
-### 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
+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.
-
-See the [theme's docs](https://github.com/cotes2020/jekyll-theme-chirpy#documentation).
 
 ## License
 
-This work is published under [MIT](https://github.com/cotes2020/chirpy-starter/blob/master/LICENSE) 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/
+[mit]: https://github.com/cotes2020/chirpy-starter/blob/master/LICENSE

_config.yml

@@ -7,14 +7,21 @@ theme: jekyll-theme-chirpy
 # change below value to '/projectname'.
 baseurl: ''
 
-# the HTML language tag › https://www.w3.org/International/questions/qa-choosing-language-tags
+# The language of the site layout › http://www.lingoes.net/en/translator/langcode.htm
-lang: en-US
+# Go to folder '_data/locales' to check the available language options
+lang: en
+
+# The lang attribute of HTML › http://www.lingoes.net/en/translator/langcode.htm
+# We can specify a language different from the layout of the content.
+# If it is not assigned, the site will use the value of 'lang' instead.
+content_lang: ''
 
 # 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
@@ -27,8 +34,6 @@ description: >-                        # used by seo meta and the atom feed
 # fill in the protocol & hostname for your site, e.g., 'https://username.github.io'
 url: ''
 
-author: your_full_name                  # change to your full name
-
 github:
   username: github_username             # change to your github username
 
@@ -36,7 +41,9 @@ twitter:
   username: twitter_username            # change to your twitter username
 
 social:
-  name: your_full_name                  # it will shows as the copyright owner in Footer
+  # 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
   links:
     # The first element serves as the copyright owner's link
@@ -47,18 +54,16 @@ social:
     # - https://www.linkedin.com/in/username
 
 google_site_verification: google_meta_tag_verification # change to your verification string
-# --------------------------
+
+# ↑ --------------------------
+
 
 google_analytics:
-  id: ''          # Fill with your Google Analytics ID
+  id: ''              # fill in your Google Analytics ID
+  # Google Analytics pageviews report settings
   pv:
-    # The Google Analytics pageviews switch.
+    proxy_endpoint:   # fill in the Google Analytics superProxy endpoint of Google App Engine
-    # DO NOT enable it unless you know how to deploy the Google Analytics superProxy.
+    cache_path:       # the local PV cache data, friendly to visitors from GFW region
-    enabled: false
-    # the next options only valid when `google_analytics.pv` is enabled.
-    proxy_url: ''
-    proxy_endpoint: ''
-    cache: false  # pv data local cache, good for the users from GFW area.
 
 # Prefer color scheme setting.
 #
@@ -105,10 +110,6 @@ kramdown:
       line_numbers: true
       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.
-permalink: /posts/:title/
-
 collections:
   tabs:
     output: true
@@ -124,6 +125,9 @@ defaults:
       layout: post
       comments: true    # Enable comments in posts.
       toc: true         # Display TOC column in posts.
+      # 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:
       path: _drafts
@@ -151,18 +155,15 @@ compress_html:
     envs: [development]
 
 exclude:
-  - vendor
+  - '*.gem'
-  - Gemfile
+  - '*.gemspec'
-  - Gemfile.lock
-  - jekyll-theme-chirpy.gemspec
   - tools
   - docs
   - README.md
   - LICENSE
   - gulpfile.js
   - node_modules
-  - package.json
+  - '*.json'
-  - package-lock.json
 
 jekyll-archives:
   enabled: [categories, tags]
@@ -172,3 +173,6 @@ jekyll-archives:
   permalinks:
     tag: /tags/:name/
     category: /categories/:name/
+
+# Outdated configuration warning
+outdated: '-- Missing configuration options! --'

_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/locales/en.yml

@@ -0,0 +1,87 @@
+# The layout text of site
+
+# ----- Commons label -----
+
+layout:
+  post: Post
+  category: Category
+  tag: Tag
+
+# The tabs of sidebar
+tabs:
+  # format: <filename_without_extension>: <value>
+  home: Home
+  categories: Categories
+  tags: Tags
+  archives: Archives
+  about: About
+
+# text displayed in the search bar
+search:
+  hint: search
+  cancel: Cancel
+
+panel:
+  lastmod: Recent Update
+  trending_tags: Trending Tags
+  toc: Contents
+
+#  The liquid date format › http://strftime.net/
+date_format:
+  tooltip: '%a, %b %e, %Y, %l:%M %p %z'
+  post:
+    long: '%b %e, %Y'
+    short: '%b %e'
+    archive_month: '%b'
+
+copyright:
+  # Shown at the bottom of the post
+  license:
+    template: This post is licensed under :LICENSE_NAME by the author.
+    name: CC BY 4.0
+    link: https://creativecommons.org/licenses/by/4.0/
+
+  # Displayed in the footer
+  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.
+
+meta: Powered by :PLATFORM with :THEME theme.
+
+not_found:
+  statment: Sorry, we've misplaced that URL or it's pointing to something that doesn't exist.
+  hint_template: :HEAD_BAK to try finding it again, or search for it on the :ARCHIVES_PAGE.
+  head_back: Head back Home
+  archives_page: Archives page
+
+# ----- Posts related labels -----
+
+post:
+  published: 'on'
+  updated: Updated
+  timeago:
+    day: d ago
+    hour: hr ago
+    minute: min ago
+    just_now: just now
+  words: words
+  pageview_measure: views
+  read_time:
+    unit: min
+    prompt: read
+  relate_posts: Further Reading
+  share: Share
+  button:
+    next: Newer
+    previous: Older
+    copy:
+      title: Copy link
+      succeed: Link copied successfully!
+  # pinned prompt of posts list on homepage
+  pin_prompt: Pinned
+
+# categories page
+categories:
+  category_measure: categories
+  post_measure: posts

_data/locales/zh-CN.yml

@@ -0,0 +1,86 @@
+# The layout text of site
+
+# ----- Commons label -----
+
+layout:
+  post: 文章
+  category: 分类
+  tag: 标签
+
+# The tabs of sidebar
+tabs:
+  # format: <filename_without_extension>: <value>
+  home: 首页
+  categories: 分类
+  tags: 标签
+  archives: 归档
+  about: 关于
+
+# text displayed in the search bar
+search:
+  hint: 搜索
+  cancel: 取消
+
+panel:
+  lastmod: 最近更新
+  trending_tags: 热门标签
+  toc: 目录
+
+#  The liquid date format › http://strftime.net/
+date_format:
+  tooltip: '%a, %F, %R %z'
+  post:
+    long: '%F'
+    short: '%m-%d'
+    archive_month: '%m月'
+
+copyright:
+  # Shown at the bottom of the post
+  license:
+    template: 本文由作者按照 :LICENSE_NAME 进行授权
+    name: CC BY 4.0
+    link: https://creativecommons.org/licenses/by/4.0/
+
+  # Displayed in the footer
+  brief: 保留部分权利。
+  verbose: >-
+    除非另有说明，本网站上的博客文章均由作者按照知识共享署名 4.0 国际 (CC BY 4.0) 许可协议进行授权。
+
+meta: 本站由 :PLATFORM 生成，采用 :THEME 主题。
+
+not_found:
+  statment: 抱歉，我们放错了该 URL，或者它指向了不存在的内容。
+  hint_template: :HEAD_BAK尝试再次查找它，或在:ARCHIVES_PAGE上搜索它。
+  head_back: 返回主页
+  archives_page: 归档页面
+
+# ----- Posts related labels -----
+
+post:
+  published: 发表于
+  updated: 更新于
+  timeago:
+    day: 天前
+    hour: 小时前
+    minute: 分钟前
+    just_now: 刚刚
+  words: 字
+  pageview_measure: 次浏览
+  read_time:
+    unit: 分钟
+    prompt: 阅读
+  relate_posts: 相关文章
+  share: 分享
+  button:
+    next: 下一篇
+    previous: 上一篇
+    copy:
+      title: 分享链接
+      succeed: 链接已复制！
+  # pinned prompt of posts list on homepage
+  pin_prompt: 顶置
+
+# categories page
+categories:
+  category_measure: 个分类
+  post_measure: 篇文章

_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.

app.js

@@ -1,8 +0,0 @@
----
-layout: compress
----
-
-/* Registering Service Worker */
-if('serviceWorker' in navigator) {
-  navigator.serviceWorker.register('{{ "/sw.js" | relative_url }}');
-};

feed.xml

@@ -1,60 +0,0 @@
----
-layout: compress
-# Atom Feed, reference: https://validator.w3.org/feed/docs/atom.html
----
-
-{% capture source %}
-<feed xmlns="http://www.w3.org/2005/Atom">
-  <id>{{ "/" | absolute_url }}</id>
-  <title>{{ site.title }}</title>
-  <subtitle>{{ site.description }}</subtitle>
-  <updated>{{ site.time | date_to_xmlschema }}</updated>
-  <author>
-    <name>{{ site.author }}</name>
-    <uri>{{ "/" | absolute_url }}</uri>
-  </author>
-  <link rel="self" type="application/atom+xml" href="{{ page.url | absolute_url }}"/>
-  <link rel="alternate" type="text/html" hreflang="{{ site.lang | default: 'en' }}"
-    href="{{ '/' | absolute_url }}"/>
-  <generator uri="https://jekyllrb.com/" version="{{ jekyll.version }}">Jekyll</generator>
-  <rights> © {{ 'now' | date: '%Y' }} {{ site.author }} </rights>
-  <icon>{{ site.baseurl }}/assets/img/favicons/favicon.ico</icon>
-  <logo>{{ site.baseurl }}/assets/img/favicons/favicon-96x96.png</logo>
-
-{% for post in site.posts limit: 5 %}
-  {% assign post_absolute_url = post.url | absolute_url %}
-  <entry>
-    <title>{{ post.title }}</title>
-    <link href="{{ post_absolute_url }}" rel="alternate" type="text/html" title="{{ post.title }}" />
-    <published>{{ post.date | date_to_xmlschema }}</published>
-  {% if post.last_modified_at %}
-    <updated>{{ post.last_modified_at | date_to_xmlschema }}</updated>
-  {% else %}
-    <updated>{{ post.date | date_to_xmlschema }}</updated>
-  {% endif %}
-    <id>{{ post_absolute_url }}</id>
-    <content src="{{ post_absolute_url }}" />
-    <author>
-      <name>{{ site.author }}</name>
-    </author>
-
-  {% if post.categories %}
-    {% for category in post.categories %}
-    <category term="{{ category }}" />
-    {% endfor %}
-  {% endif %}
-
-  {% if post.summary %}
-    <summary>{{ post.summary | strip }}</summary>
-  {% else %}
-    <summary>
-      {% include no-linenos.html content=post.content %}
-      {{ content  | strip_html | truncate: 400 }}
-    </summary>
-  {% endif %}
-
-  </entry>
-{% endfor %}
-</feed>
-{% endcapture %}
-{{ source | replace: '&', '&amp;' }}

robots.txt

@@ -1,10 +0,0 @@
----
-permalink: robots.txt
-# The robots rules
----
-
-User-agent: *
-
-Disallow: /norobots/
-
-Sitemap: {{ '/sitemap.xml' | absolute_url }}

sw.js

@@ -1,61 +0,0 @@
----
-layout: compress
-# PWA service worker
----
-
-self.importScripts('{{ "/assets/js/data/cache-list.js" | relative_url }}');
-
-var cacheName = 'chirpy-{{ "now" | date: "%Y%m%d.%H%M" }}';
-
-
-function isExcluded(url) {
-  const regex = /(^http(s)?|^\/)/; /* the regex for CORS url or relative url */
-  for (const rule of exclude) {
-    if (!regex.test(url) ||
-      url.indexOf(rule) != -1) {
-      return true;
-    }
-  }
-  return false;
-}
-
-
-self.addEventListener('install', (e) => {
-  self.skipWaiting();
-  e.waitUntil(
-    caches.open(cacheName).then((cache) => {
-      return cache.addAll(include);
-    })
-  );
-});
-
-
-self.addEventListener('fetch', (e) => {
-  e.respondWith(
-    caches.match(e.request).then((r) => {
-      /* console.log('[Service Worker] Fetching resource: ' + e.request.url); */
-      return r || fetch(e.request).then((response) => {
-        return caches.open(cacheName).then((cache) => {
-          if (!isExcluded(e.request.url)) {
-            /* console.log('[Service Worker] Caching new resource: ' + e.request.url); */
-            cache.put(e.request, response.clone());
-          }
-          return response;
-        });
-      });
-    })
-  );
-});
-
-
-self.addEventListener('activate', (e) => {
-  e.waitUntil(
-    caches.keys().then((keyList) => {
-          return Promise.all(keyList.map((key) => {
-        if(key !== cacheName) {
-          return caches.delete(key);
-        }
-      }));
-    })
-  );
-});