diff --git a/.editorconfig b/.editorconfig index f27e9a9..2b740bf 100644 --- a/.editorconfig +++ b/.editorconfig @@ -9,8 +9,11 @@ trim_trailing_whitespace = true end_of_line = lf insert_final_newline = true -[*.js] -indent_size = 4 +[*.{js,css,scss}] +quote_type = single + +[*.{yml,yaml}] +quote_type = double [*.md] trim_trailing_whitespace = false diff --git a/.github/workflows/pages-deploy.yml b/.github/workflows/pages-deploy.yml index 356d42a..a0de59d 100644 --- a/.github/workflows/pages-deploy.yml +++ b/.github/workflows/pages-deploy.yml @@ -37,7 +37,7 @@ jobs: - name: Setup Pages id: pages - uses: actions/configure-pages@v1 + uses: actions/configure-pages@v3 - name: Setup Ruby uses: ruby/setup-ruby@v1 diff --git a/.gitignore b/.gitignore index 9735d33..0124b68 100644 --- a/.gitignore +++ b/.gitignore @@ -1,21 +1,22 @@ -# hidden files -.* -!.git* -!.editorconfig -!.nojekyll -!.husky -!.commitlintrc.json -!.versionrc.json -!.stylelintrc.json - -# bundler cache -_site +# Bundler cache +.bundle 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 diff --git a/Gemfile b/Gemfile index 06f67fd..eb7b217 100644 --- a/Gemfile +++ b/Gemfile @@ -2,7 +2,7 @@ source "https://rubygems.org" -gem "jekyll-theme-chirpy", "~> 5.5", ">= 5.5.2" +gem "jekyll-theme-chirpy", "~> 5.6", ">= 5.6.0" group :test do gem "html-proofer", "~> 3.18" diff --git a/README.md b/README.md index 4f4c00f..9b4e987 100644 --- a/README.md +++ b/README.md @@ -18,11 +18,11 @@ To save you time, and also in case you lose some files while copying, we extract ## Prerequisites -Follow the instructions in the [Jekyll Docs](https://jekyllrb.com/docs/installation/) to complete the installation of `Ruby`, `RubyGems`, `Jekyll` and `Bundler`. +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**][use-template] to generate a brand new repository and name it `.github.io`, where `GH_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: diff --git a/_config.yml b/_config.yml index f3a1229..7ed3e72 100644 --- a/_config.yml +++ b/_config.yml @@ -5,60 +5,59 @@ 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: '' +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'. lang: en - # Change to your timezone › http://www.timezoneconverter.com/cgi-bin/findzone/findzone timezone: # jekyll-seo-tag settings › https://github.com/jekyll/jekyll-seo-tag/blob/master/docs/usage.md # ↓ -------------------------- -title: Chirpy # the main title +title: Chirpy # the main title -tagline: A text-focused Jekyll theme # it will display as the sub-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, responsive, and powerful Jekyll theme for presenting professional writing. +description: >- # used by seo meta and the atom feed + A minimal, responsive and feature-rich Jekyll theme for technical writing. # fill in the protocol & hostname for your site, e.g., 'https://username.github.io' -url: '' +url: "" github: - username: github_username # change to your github username + username: github_username # change to your github username twitter: - username: twitter_username # change to your twitter username + username: twitter_username # change to your twitter username 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@domain.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 - - https://github.com/username # change to your github homepage + - https://twitter.com/username # change to your twitter homepage + - https://github.com/username # 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 +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 + 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. # @@ -71,7 +70,7 @@ google_analytics: # light - Use the light color scheme # dark - Use the dark color scheme # -theme_mode: # [light|dark] +theme_mode: # [light|dark] # The CDN endpoint for images. # Notice that once it is assigned, the CDN url @@ -83,39 +82,39 @@ img_cdn: # the avatar on sidebar, support local or CORS resources avatar: -# boolean type, the global switch for ToC in posts. +# 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 + active: # The global switch for posts comments, e.g., 'disqus'. Keep it empty means disable # The active options are as follows: disqus: - shortname: # fill with the Disqus shortname. › https://help.disqus.com/en/articles/1717111-what-s-a-shortname + shortname: # fill with the Disqus shortname. › https://help.disqus.com/en/articles/1717111-what-s-a-shortname # utterances settings › https://utteranc.es/ utterances: - repo: # / - issue_term: # < url | pathname | title | ...> + repo: # / + issue_term: # < url | pathname | title | ...> # Giscus options › https://giscus.app giscus: - repo: # / + 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` + 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 + 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 paginate: 10 @@ -123,7 +122,7 @@ paginate: 10 kramdown: syntax_highlighter: rouge - syntax_highlighter_opts: # Rouge Options › https://github.com/jneen/rouge#full-options + syntax_highlighter_opts: # Rouge Options › https://github.com/jneen/rouge#full-options css_class: highlight # default_lang: console span: @@ -139,12 +138,12 @@ collections: defaults: - 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 - comments: true # Enable comments in posts. - toc: true # Display TOC column in posts. + 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/ @@ -153,8 +152,8 @@ defaults: values: comments: false - scope: - path: '' - type: tabs # see `site.collections` + path: "" + type: tabs # see `site.collections` values: layout: page permalink: /:title/ @@ -180,13 +179,13 @@ compress_html: envs: [development] exclude: - - '*.gem' - - '*.gemspec' + - "*.gem" + - "*.gemspec" - tools - README.md - CHANGELOG.md - LICENSE - - gulpfile.js + - rollup.config.js - node_modules - package*.json diff --git a/_data/contact.yml b/_data/contact.yml index a94e555..76b667a 100644 --- a/_data/contact.yml +++ b/_data/contact.yml @@ -1,30 +1,28 @@ # The contact options. -- - type: github - icon: 'fab fa-github' -- - 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: github + icon: "fab fa-github" +- 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 # Uncomment and complete the url below to enable more contact options -# - -# type: mastodon +# +# - type: mastodon # icon: 'fab fa-mastodon' # icons powered by # 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 # url: '' # Fill with your Linkedin homepage -# - -# type: stack-overflow +# +# - type: stack-overflow # icon: 'fab fa-stack-overflow' # url: '' # Fill with your stackoverflow homepage diff --git a/_data/share.yml b/_data/share.yml index 1206f4d..c1d4d63 100644 --- a/_data/share.yml +++ b/_data/share.yml @@ -2,26 +2,24 @@ # Icons from platforms: - - - type: Twitter + - type: 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://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" diff --git a/assets/lib b/assets/lib index e372141..24ebdb7 160000 --- a/assets/lib +++ b/assets/lib @@ -1 +1 @@ -Subproject commit e372141074f370c6f03b68b5264e7663f2b7477c +Subproject commit 24ebdb708f3f5451df953cb5f9deb3ad4433404a