From 74bf950ae0fa49baf80110bf831a0b2424bee806 Mon Sep 17 00:00:00 2001 From: GitHub Actions Date: Sun, 10 Sep 2023 13:24:09 +0000 Subject: [PATCH] Update critical file(s) according to Chirpy v6.2.0 --- .github/workflows/pages-deploy.yml | 8 +++++--- Gemfile | 4 ++-- README.md | 27 +++++++++++++++++++-------- _config.yml | 4 ++-- _data/contact.yml | 2 +- _data/share.yml | 2 +- assets/lib | 2 +- 7 files changed, 31 insertions(+), 18 deletions(-) diff --git a/.github/workflows/pages-deploy.yml b/.github/workflows/pages-deploy.yml index 1c4bd9d..87089c9 100644 --- a/.github/workflows/pages-deploy.yml +++ b/.github/workflows/pages-deploy.yml @@ -28,7 +28,7 @@ jobs: steps: - name: Checkout - uses: actions/checkout@v3 + uses: actions/checkout@v4 with: fetch-depth: 0 # submodules: true @@ -42,7 +42,7 @@ jobs: - name: Setup Ruby uses: ruby/setup-ruby@v1 with: - ruby-version: 3 # reads from a '.ruby-version' or '.tools-version' file if 'ruby-version' is omitted + ruby-version: 3 bundler-cache: true - name: Build site @@ -52,7 +52,9 @@ jobs: - name: Test site run: | - bundle exec htmlproofer _site --disable-external --check-html --allow_hash_href + bundle exec htmlproofer _site \ + \-\-disable-external=true \ + \-\-ignore-urls "/^http:\/\/127.0.0.1/,/^http:\/\/0.0.0.0/,/^http:\/\/localhost/" - name: Upload site artifact uses: actions/upload-pages-artifact@v1 diff --git a/Gemfile b/Gemfile index 1d5342c..ae1d479 100644 --- a/Gemfile +++ b/Gemfile @@ -2,10 +2,10 @@ source "https://rubygems.org" -gem "jekyll-theme-chirpy", "~> 6.1" +gem "jekyll-theme-chirpy", "~> 6.2" 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 diff --git a/README.md b/README.md index 9b4e987..05bd1ec 100644 --- a/README.md +++ b/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 ``` diff --git a/_config.yml b/_config.yml index 0f74571..7dc8685 100644 --- a/_config.yml +++ b/_config.yml @@ -12,7 +12,7 @@ baseurl: "" # 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 +# Change to your timezone › https://kevinnovak.github.io/Time-Zone-Picker timezone: # jekyll-seo-tag settings › https://github.com/jekyll/jekyll-seo-tag/blob/master/docs/usage.md @@ -177,12 +177,12 @@ compress_html: exclude: - "*.gem" - "*.gemspec" + - docs - tools - README.md - CHANGELOG.md - LICENSE - rollup.config.js - - node_modules - package*.json jekyll-archives: diff --git a/_data/contact.yml b/_data/contact.yml index 76b667a..1ed228a 100644 --- a/_data/contact.yml +++ b/_data/contact.yml @@ -4,7 +4,7 @@ icon: "fab fa-github" - type: twitter - icon: "fab fa-twitter" + icon: "fa-brands fa-x-twitter" - type: email icon: "fas fa-envelope" diff --git a/_data/share.yml b/_data/share.yml index c1d4d63..feede74 100644 --- a/_data/share.yml +++ b/_data/share.yml @@ -3,7 +3,7 @@ platforms: - type: Twitter - icon: "fab fa-twitter" + icon: "fa-brands fa-square-x-twitter" link: "https://twitter.com/intent/tweet?text=TITLE&url=URL" - type: Facebook diff --git a/assets/lib b/assets/lib index 557de30..6737eab 160000 --- a/assets/lib +++ b/assets/lib @@ -1 +1 @@ -Subproject commit 557de301fe393fb4660a338ae3c1b72ec2b3bf7c +Subproject commit 6737eab720e4cdd8330d32053053356f200d8819