Update the site config according to the theme (v3.1.0)

README.md

@@ -2,32 +2,20 @@
 
 The startup template for [**Jekyll Theme Chirpy**][chirpy].
 
-When installing the `jekyll-theme-chirpy` through [RubyGem][gem], Jekyll can only read files in the folders `_includes`, `_layout`, `_sass` and `assets`, as well as a small part of variables of the file `_config.yml` from the theme's gem (use the command `bundle info --path jekyll-theme-chirpy` to locate). To fully use all the features of `jekyll-theme-chirpy`, you also need to copy other files/directories and site variables from the theme's gem to your Jekyll site. This will be boring, so we extract all the other required things of the theme's gem to help you quickly use `jekyll-theme-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.
-
-[gem]: https://rubygems.org/gems/jekyll-theme-chirpy
-[chirpy]: https://github.com/cotes2020/jekyll-theme-chirpy/
-
-**File Directory Struct**
 
 ```shell
-.
+# The critical files/directories to run the theme
-├── .github
+├── _data
-│   └── workflows
+├── _plugins
-│       └── pages-deploy.yml    # the GitHub Actions workflow
+├── _tabs
-├── Gemfile
+├── _config.yml
-├── LICENSE
+├── app.js
-├── README.md                   # this file
+├── feed.xml
-├── _config.yml                 # all variables are from the theme's gem, except the option `theme`
+├── index.html
-├── _data                       # from the theme's gem
+├── robots.txt
-├── _plugins                    # idem
+├── sw.js
-├── _tabs                       # idem
+└── 404.html
-├── app.js                      # idem
-├── feed.xml                    # idem
-├── index.html                  # idem
-├── 404.html                    # idem
-├── robots.txt                  # idem
-└── sw.js                       # idem
-
 ```
 
 ## Installation
@@ -59,7 +47,7 @@ And then add the following content:
 
 ### Changing the Number of Tabs
 
-When adding or deleting files in the `_tabs` folder, you need to complete [Custom Stylesheet](#custom-stylesheet) first, and then add a new line before `@import`:
+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 }};
@@ -86,3 +74,6 @@ See the [theme's docs](https://github.com/cotes2020/jekyll-theme-chirpy#document
 ## License
 
 This work is published under [MIT](https://github.com/cotes2020/chirpy-starter/blob/master/LICENSE) License.
+
+[gem]: https://rubygems.org/gems/jekyll-theme-chirpy
+[chirpy]: https://github.com/cotes2020/jekyll-theme-chirpy/

_config.yml

@@ -1,7 +1,17 @@
-# import theme
+# The Site Configuration
+
+# Import the theme
 theme: jekyll-theme-chirpy
 
-# The Site Configuration
+# 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
 # --------------------------
@@ -39,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:
@@ -58,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,
@@ -72,7 +69,6 @@ disqus:
 # Available options:
 #
 #     light  - Use the light color scheme
-#
 #     dark   - Use the dark color scheme
 #
 theme_mode:   # [light|dark]
@@ -90,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
@@ -104,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:
@@ -122,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
@@ -186,8 +152,9 @@ compress_html:
 
 exclude:
   - vendor
-  - Gemfile.lock
   - Gemfile
+  - Gemfile.lock
+  - jekyll-theme-chirpy.gemspec
   - tools
   - docs
   - README.md