feat: update templates

See also: https://github.com/cotes2020/jekyll-theme-chirpy/pull/1431


Co-authored-by: Dmitry Kosarev <kosarevdmlive@outlook.com>

.github/workflows/pages-deploy.yml

@@ -37,12 +37,12 @@ jobs:
 
       - name: Setup Pages
         id: pages
-        uses: actions/configure-pages@v3
+        uses: actions/configure-pages@v4
 
       - name: Setup Ruby
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 3.2
+          ruby-version: 3.3
           bundler-cache: true
 
       - name: Build site
@@ -53,11 +53,11 @@ jobs:
       - name: Test site
         run: |
           bundle exec htmlproofer _site \
-            \-\-disable-external=true \
+            \-\-disable-external \
             \-\-ignore-urls "/^http:\/\/127.0.0.1/,/^http:\/\/0.0.0.0/,/^http:\/\/localhost/"
 
       - name: Upload site artifact
-        uses: actions/upload-pages-artifact@v1
+        uses: actions/upload-pages-artifact@v3
         with:
           path: "_site${{ steps.pages.outputs.base_path }}"
 
@@ -70,4 +70,4 @@ jobs:
     steps:
       - name: Deploy to GitHub Pages
         id: deployment
-        uses: actions/deploy-pages@v2
+        uses: actions/deploy-pages@v4

.gitignore

@@ -5,6 +5,7 @@ Gemfile.lock
 
 # Jekyll cache
 .jekyll-cache
+.jekyll-metadata
 _site
 
 # RubyGems
@@ -17,6 +18,9 @@ package-lock.json
 # IDE configurations
 .idea
 .vscode
+!.vscode/settings.json
+!.vscode/extensions.json
 
 # Misc
+_sass/dist
 assets/js/dist

Gemfile

@@ -2,22 +2,8 @@
 
 source "https://rubygems.org"
 
-gem "jekyll-theme-chirpy", "~> 6.4", ">= 6.4.2"
+gem "jekyll-theme-chirpy", "~> 7.0", ">= 7.0.1"
 
 group :test do
-  gem "html-proofer", "~> 4.4"
+  gem "html-proofer", "~> 5.0"
 end
-
-# Windows and JRuby does not include zoneinfo files, so bundle the tzinfo-data gem
-# and associated library.
-platforms :mingw, :x64_mingw, :mswin, :jruby do
-  gem "tzinfo", ">= 1", "< 3"
-  gem "tzinfo-data"
-end
-
-# Performance-booster for watching directories on Windows
-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,10 +1,18 @@
-# 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]
+# Chirpy Starter
 
-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.
+[![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 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.
+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.
 
-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 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.
+
+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
 .
@@ -14,19 +22,22 @@ To fully use all the features of **Chirpy**, you need to copy the other critical
 └── index.html
 ```
 
-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.
+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.
+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
 
-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.
+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.
 
 Then clone it to your local machine and run:
 
-```
+```console
 $ bundle
 ```
 
@@ -34,6 +45,11 @@ $ bundle
 
 Please see the [theme's docs](https://github.com/cotes2020/jekyll-theme-chirpy#documentation).
 
+## Contributing
+
+The contents of this repository are automatically updated when new releases are made to the [main repository][chirpy].  
+If you have problems using it, or would like to participate in improving it, please go to the main repository for feedback!
+
 ## License
 
 This work is published under [MIT][mit] License.

_config.yml

@@ -3,10 +3,6 @@
 # Import the theme
 theme: jekyll-theme-chirpy
 
-# Change the following value to '/PROJECT_NAME' ONLY IF your site type is GitHub Pages Project sites
-# and doesn't have a custom domain.
-baseurl: ""
-
 # The language of the webpage › http://www.lingoes.net/en/translator/langcode.htm
 # If it has the same name as one of the files in folder `_data/locales`, the layout language will also be changed,
 # otherwise, the layout language will use the default value of 'en'.
@@ -27,7 +23,8 @@ tagline: >- # it will display as the sub-title
 description: >- # used by seo meta and the atom feed
   Recording Life.
 
-# fill in the protocol & hostname for your site, e.g., 'https://username.github.io'
+# Fill in the protocol & hostname for your site.
+# e.g. 'https://username.github.io', note that it does not end with a '/'.
 url: "https://log.zxcvber.com"
 
 github:
@@ -43,18 +40,42 @@ social:
   email: calofmijuck@snu.ac.kr # 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
     - https://github.com/calofmijuck # change to your github homepage
     # Uncomment below to add more social links
     # - https://www.facebook.com/username
     # - https://www.linkedin.com/in/username
 
-google_site_verification: # fill in to your verification string
+# Site Verification Settings
+webmaster_verifications:
+  google: # fill in your Google verification code
+  bing: # fill in your Bing verification code
+  alexa: # fill in your Alexa verification code
+  yandex: # fill in your Yandex verification code
+  baidu: # fill in your Baidu verification code
+  facebook: # fill in your Facebook verification code
 
 # ↑ --------------------------
 # The end of `jekyll-seo-tag` settings
 
-google_analytics:
+# Web Analytics Settings
-  id: # fill in your Google Analytics ID
+analytics:
+  google:
+    id: # fill in your Google Analytics ID
+  goatcounter:
+    id: # fill in your GoatCounter ID
+  umami:
+    id: # fill in your Umami ID
+    domain: # fill in your Umami domain
+  matomo:
+    id: # fill in your Matomo ID
+    domain: # fill in your Matomo domain
+  cloudflare:
+    id: # fill in your Cloudflare Web Analytics token
+
+# Pageviews settings
+pageviews:
+  provider: # now only supports 'goatcounter'
 
 # Prefer color scheme setting.
 #
@@ -67,24 +88,29 @@ google_analytics:
 #     light  - Use the light color scheme
 #     dark   - Use the dark color scheme
 #
-theme_mode: light
+theme_mode: light # [light | dark]
 
-# The CDN endpoint for images.
+# The CDN endpoint for media resources.
 # Notice that once it is assigned, the CDN url
-# will be added to all image (site avatar & posts' images) paths starting with '/'
+# will be added to all media resources (site avatar, posts' images, audio and video files) paths starting with '/'
 #
 # e.g. 'https://cdn.com'
-img_cdn: "https://blog.zxcvber.com"
+cdn: "https://blog.zxcvber.com"
 
 # the avatar on sidebar, support local or CORS resources
 avatar: assets/img/avatar.png
 
+# The URL of the site-wide social preview image used in SEO `og:image` meta tag.
+# It can be overridden by a customized `page.image` in front matter.
+social_preview_image: # string, local or CORS resources
+
 # boolean type, the global switch for TOC in posts.
 toc: true
 
 comments:
-  active: # The global switch for posts comments, e.g., 'disqus'.  Keep it empty means disable
+  # Global switch for the post comment system. Keeping it empty means disabled.
-  # The active options are as follows:
+  provider: # [disqus | utterances | giscus]
+  # The provider 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/
@@ -98,6 +124,7 @@ comments:
     category:
     category_id:
     mapping: # optional, default to 'pathname'
+    strict: # optional, default to '0'
     input_position: # optional, default to 'bottom'
     lang: # optional, default to the value of `site.lang`
     reactions_enabled: # optional, default to the value of `1`
@@ -108,16 +135,27 @@ assets:
     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]
+    env: # [development | production]
 
 pwa:
-  enabled: true # the option for PWA feature
+  enabled: true # the option for PWA feature (installable)
+  cache:
+    enabled: true # the option for PWA offline cache
+    # Paths defined here will be excluded from the PWA cache.
+    # Usually its value is the `baseurl` of another website that
+    # shares the same domain name as the current website.
+    deny_paths:
+      # - "/example"  # URLs match `<SITE_URL>/example/*` will not be cached by the PWA
 
 paginate: 10
 
+# The base URL of your site
+baseurl: ""
+
 # ------------ The following options are not recommended to be modified ------------------
 
 kramdown:
+  footnote_backlink: "&#8617;&#xfe0e;"
   syntax_highlighter: rouge
   syntax_highlighter_opts: # Rouge Options › https://github.com/jneen/rouge#full-options
     css_class: highlight
@@ -183,9 +221,8 @@ exclude:
   - docs
   - tools
   - README.md
-  - CHANGELOG.md
   - LICENSE
-  - rollup.config.js
+  - "*.config.js"
   - package*.json
 
 jekyll-archives:

_data/locales/en.yml

@@ -1,91 +1,5 @@
-# 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
-
-# the text displayed in the search bar & search results
-search:
-  hint: search
-  cancel: Cancel
-  no_results: Oops! No results found.
-
-panel:
-  lastmod: Recently Updated
-  trending_tags: Trending Tags
-  toc: Contents
-
 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: All 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: ""
-
-not_found:
-  statment: Sorry, we've misplaced that URL or it's pointing to something that doesn't exist.
-
-notification:
-  update_found: A new version of content is available.
-  update: Update
-
-# ----- Posts related labels -----
-
-post:
-  written_by: By
-  posted: Posted
-  updated: Updated
-  words: words
-  pageview_measure: views
-  read_time:
-    unit: min
-    prompt: read
-  relate_posts: Further Reading
-  share: Share
-  button:
-    next: Newer
-    previous: Older
-    copy_code:
-      succeed: Copied!
-    share_link:
-      title: Copy link
-      succeed: Link copied successfully!
-
-# Date time format.
-# See: <http://strftime.net/>, <https://day.js.org/docs/en/display/format>
-df:
-  post:
-    strftime: "%b %e, %Y"
-    dayjs: "ll"
-  archives:
-    strftime: "%b"
-    dayjs: "MMM"
-
-# categories page
-categories:
-  category_measure:
-    singular: category
-    plural: categories
-  post_measure:
-    singular: post
-    plural: posts

_data/share.yml

@@ -2,20 +2,37 @@
 #  Icons from <https://fontawesome.com/>
 
 platforms:
-  - type: Facebook
+  # - type: Twitter
-    icon: "fab fa-facebook-square"
+  #   icon: "fa-brands fa-square-x-twitter"
-    link: "https://www.facebook.com/sharer/sharer.php?title=TITLE&u=URL"
+  #   link: "https://twitter.com/intent/tweet?text=TITLE&url=URL"
 
-  - type: Twitter
+  # - type: Facebook
-    icon: "fa-brands fa-square-x-twitter"
+  #   icon: "fab fa-facebook-square"
-    link: "https://twitter.com/intent/tweet?text=TITLE&url=URL"
+  #   link: "https://www.facebook.com/sharer/sharer.php?title=TITLE&u=URL"
+
+  # - type: Telegram
+  #   icon: "fab fa-telegram"
+  #   link: "https://t.me/share/url?url=URL&text=TITLE"
 
   # Uncomment below if you need to.
   #
-  # - type: Linkedin
+  - type: Linkedin
-  #   icon: "fab fa-linkedin"
+    icon: "fab fa-linkedin"
-  #   link: "https://www.linkedin.com/sharing/share-offsite/?url=URL"
+    link: "https://www.linkedin.com/sharing/share-offsite/?url=URL"
   #
   # - type: Weibo
   #   icon: "fab fa-weibo"
-  #   link: "http://service.weibo.com/share/share.php?title=TITLE&url=URL"
+  #   link: "https://service.weibo.com/share/share.php?title=TITLE&url=URL"
+  #
+  # - type: Mastodon
+  #   icon: "fa-brands fa-mastodon"
+  #   # See: https://github.com/justinribeiro/share-to-mastodon#properties
+  #   instances:
+  #     - label: mastodon.social
+  #       link: "https://mastodon.social/"
+  #     - label: mastodon.online
+  #       link: "https://mastodon.online/"
+  #     - label: fosstodon.org
+  #       link: "https://fosstodon.org/"
+  #     - label: photog.social
+  #       link: "https://photog.social/"

_layouts/post.html

@@ -1,5 +1,5 @@
 ---
-layout: page
+layout: default
 refactor: true
 panel_includes:
   - toc
@@ -11,98 +11,117 @@ tail_includes:
 
 {% include lang.html %}
 
-<header>
+<article class="px-1">
-  <h1 data-toc-skip>{{ page.title }}</h1>
+  <header>
+    <h1 data-toc-skip>{{ page.title }}</h1>
+    {% if page.description %}
+    <p class="post-desc fw-light mb-4">{{ page.description }}</p>
+    {% endif %}
 
-  <div class="post-meta text-muted">
+    <div class="post-meta text-muted">
-    <!-- published date -->
+      <!-- published date -->
-    <span>
-      {{ site.data.locales[lang].post.posted }}
-      {% include datetime.html date=page.date tooltip=true lang=lang %}
-    </span>
-
-    <div class="d-flex justify-content-between">
-      <!-- author(s) -->
       <span>
-        {% if page.author %}
+        {{ site.data.locales[lang].post.posted }} {% include datetime.html
-          {% assign authors = page.author %}
+        date=page.date tooltip=true lang=lang %}
-        {% elsif page.authors %}
-          {% assign authors = page.authors %}
-        {% endif %}
-
-        {{ site.data.locales[lang].post.written_by }}
-
-        <em>
-          {% if authors %}
-            {% for author in authors %}
-              <a href="{{ site.data.authors[author].url }}">{{ site.data.authors[author].name }}</a>
-              {% unless forloop.last %}{{ '</em>, <em>' }}{% endunless %}
-            {% endfor %}
-          {% else %}
-            <a href="{{ site.social.links[0] }}">{{ site.social.name }}</a>
-          {% endif %}
-        </em>
       </span>
 
-      <!-- read time -->
+      <!-- lastmod date -->
-      {% include read-time.html content=content prompt=true lang=lang %}
+      {% if page.last_modified_at and page.last_modified_at != page.date %}
+      <span>
+        {{ site.data.locales[lang].post.updated }} {% include datetime.html
+        date=page.last_modified_at tooltip=true lang=lang %}
+      </span>
+      {% endif %}
+
+      <div class="d-flex justify-content-between">
+        <!-- author(s) -->
+        <span>
+          {% if page.author %} {% assign authors = page.author %} {% elsif
+          page.authors %} {% assign authors = page.authors %} {% endif %} {{
+          site.data.locales[lang].post.written_by }}
+
+          <em>
+            {% if authors %} {% for author in authors %} {% if
+            site.data.authors[author].url -%}
+            <a href="{{ site.data.authors[author].url }}"
+              >{{ site.data.authors[author].name }}</a
+            >
+            {%- else -%} {{ site.data.authors[author].name }} {%- endif %} {%
+            unless forloop.last %}{{ '</em
+          >,
+          <em
+            >' }}{% endunless %} {% endfor %} {% else %}
+            <a href="{{ site.social.links[0] }}">{{ site.social.name }}</a>
+            {% endif %}
+          </em>
+        </span>
+
+        <div>
+          <!-- pageviews -->
+          {% if site.pageviews.provider and
+          site.analytics[site.pageviews.provider].id %}
+          <span>
+            <em id="pageviews">
+              <i class="fas fa-spinner fa-spin small"></i>
+            </em>
+            {{ site.data.locales[lang].post.pageview_measure }}
+          </span>
+          {% endif %}
+
+          <!-- read time -->
+          {% include read-time.html content=content prompt=true lang=lang %}
+        </div>
+      </div>
     </div>
-    <!-- .d-flex -->
+  </header>
-  </div>
-  <!-- .post-meta -->
-</header>
 
-<div class="content">
+  <div class="content">{{ content }}</div>
-  {{ content }}
-</div>
 
-<div class="post-tail-wrapper text-muted">
+  <div class="post-tail-wrapper text-muted">
-  <!-- categories -->
+    <!-- categories -->
-  {% if page.categories.size > 0 %}
+    {% if page.categories.size > 0 %}
     <div class="post-meta mb-3">
       <i class="far fa-folder-open fa-fw me-1"></i>
       {% for category in page.categories %}
-        <a href="{{ site.baseurl }}/categories/{{ category | slugify | url_encode }}/">{{ category }}</a>
+      <a
-        {%- unless forloop.last -%},{%- endunless -%}
+        href="{{ site.baseurl }}/categories/{{ category | slugify | url_encode }}/"
-      {% endfor %}
+        >{{ category }}</a
+      >
+      {%- unless forloop.last -%},{%- endunless -%} {% endfor %}
     </div>
-  {% endif %}
+    {% endif %}
 
-  <!-- tags -->
+    <!-- tags -->
-  {% if page.tags.size > 0 %}
+    {% if page.tags.size > 0 %}
     <div class="post-tags">
       <i class="fa fa-tags fa-fw me-1"></i>
       {% for tag in page.tags %}
-        <a
+      <a
-          href="{{ site.baseurl }}/tags/{{ tag | slugify | url_encode }}/"
+        href="{{ site.baseurl }}/tags/{{ tag | slugify | url_encode }}/"
-          class="post-tag no-text-decoration"
+        class="post-tag no-text-decoration"
-        >
+      >
-          {{- tag -}}
+        {{- tag -}}
-        </a>
+      </a>
       {% endfor %}
     </div>
-  {% endif %}
+    {% endif %}
 
-  <div
+    <div
-    class="
+      class="post-tail-bottom d-flex justify-content-between align-items-center mt-5 pb-2"
-      post-tail-bottom
+    >
-      d-flex justify-content-between align-items-center mt-5 pb-2
+      <div class="license-wrapper">
-    "
+        {% if site.data.locales[lang].copyright.license.template %} {% capture
-  >
+        _replacement %}
-    <div class="license-wrapper">
-      {% if site.data.locales[lang].copyright.license.template %}
-        {% capture _replacement %}
         <a href="{{ site.data.locales[lang].copyright.license.link }}">
           {{ site.data.locales[lang].copyright.license.name }}
         </a>
-        {% endcapture %}
+        {% endcapture %} {{ site.data.locales[lang].copyright.license.template |
+        replace: ':LICENSE_NAME', _replacement }} {% endif %}
+      </div>
 
-        {{ site.data.locales[lang].copyright.license.template | replace: ':LICENSE_NAME', _replacement }}
+      {% include post-sharing.html lang=lang %}
-      {% endif %}
     </div>
-
+    <!-- .post-tail-bottom -->
-    {% include post-sharing.html lang=lang %}
   </div>
-  <!-- .post-tail-bottom -->
+  <!-- div.post-tail-wrapper -->
-</div>
+</article>
-<!-- div.post-tail-wrapper -->