mirror of
https://github.com/cotes2020/chirpy-starter.git
synced 2025-04-12 07:33:27 +10:00
Update critical file(s) according to Chirpy v6.2.0
This commit is contained in:
parent
2605fedb3f
commit
74bf950ae0
8
.github/workflows/pages-deploy.yml
vendored
8
.github/workflows/pages-deploy.yml
vendored
@ -28,7 +28,7 @@ jobs:
|
|||||||
|
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout
|
- name: Checkout
|
||||||
uses: actions/checkout@v3
|
uses: actions/checkout@v4
|
||||||
with:
|
with:
|
||||||
fetch-depth: 0
|
fetch-depth: 0
|
||||||
# submodules: true
|
# submodules: true
|
||||||
@ -42,7 +42,7 @@ jobs:
|
|||||||
- name: Setup Ruby
|
- name: Setup Ruby
|
||||||
uses: ruby/setup-ruby@v1
|
uses: ruby/setup-ruby@v1
|
||||||
with:
|
with:
|
||||||
ruby-version: 3 # reads from a '.ruby-version' or '.tools-version' file if 'ruby-version' is omitted
|
ruby-version: 3
|
||||||
bundler-cache: true
|
bundler-cache: true
|
||||||
|
|
||||||
- name: Build site
|
- name: Build site
|
||||||
@ -52,7 +52,9 @@ jobs:
|
|||||||
|
|
||||||
- name: Test site
|
- name: Test site
|
||||||
run: |
|
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
|
- name: Upload site artifact
|
||||||
uses: actions/upload-pages-artifact@v1
|
uses: actions/upload-pages-artifact@v1
|
||||||
|
4
Gemfile
4
Gemfile
@ -2,10 +2,10 @@
|
|||||||
|
|
||||||
source "https://rubygems.org"
|
source "https://rubygems.org"
|
||||||
|
|
||||||
gem "jekyll-theme-chirpy", "~> 6.1"
|
gem "jekyll-theme-chirpy", "~> 6.2"
|
||||||
|
|
||||||
group :test do
|
group :test do
|
||||||
gem "html-proofer", "~> 3.18"
|
gem "html-proofer", "~> 4.4"
|
||||||
end
|
end
|
||||||
|
|
||||||
# Windows and JRuby does not include zoneinfo files, so bundle the tzinfo-data gem
|
# Windows and JRuby does not include zoneinfo files, so bundle the tzinfo-data gem
|
||||||
|
27
README.md
27
README.md
@ -1,10 +1,18 @@
|
|||||||
# Chirpy Starter [](https://rubygems.org/gems/jekyll-theme-chirpy) [][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]
|
||||||
|
[][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
|
```shell
|
||||||
.
|
.
|
||||||
@ -14,19 +22,22 @@ To fully use all the features of **Chirpy**, you need to copy the other critical
|
|||||||
└── index.html
|
└── 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
|
## 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
|
## 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:
|
Then clone it to your local machine and run:
|
||||||
|
|
||||||
```
|
```console
|
||||||
$ bundle
|
$ bundle
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -12,7 +12,7 @@ baseurl: ""
|
|||||||
# otherwise, the layout language will use the default value of 'en'.
|
# otherwise, the layout language will use the default value of 'en'.
|
||||||
lang: 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:
|
timezone:
|
||||||
|
|
||||||
# jekyll-seo-tag settings › https://github.com/jekyll/jekyll-seo-tag/blob/master/docs/usage.md
|
# jekyll-seo-tag settings › https://github.com/jekyll/jekyll-seo-tag/blob/master/docs/usage.md
|
||||||
@ -177,12 +177,12 @@ compress_html:
|
|||||||
exclude:
|
exclude:
|
||||||
- "*.gem"
|
- "*.gem"
|
||||||
- "*.gemspec"
|
- "*.gemspec"
|
||||||
|
- docs
|
||||||
- tools
|
- tools
|
||||||
- README.md
|
- README.md
|
||||||
- CHANGELOG.md
|
- CHANGELOG.md
|
||||||
- LICENSE
|
- LICENSE
|
||||||
- rollup.config.js
|
- rollup.config.js
|
||||||
- node_modules
|
|
||||||
- package*.json
|
- package*.json
|
||||||
|
|
||||||
jekyll-archives:
|
jekyll-archives:
|
||||||
|
@ -4,7 +4,7 @@
|
|||||||
icon: "fab fa-github"
|
icon: "fab fa-github"
|
||||||
|
|
||||||
- type: twitter
|
- type: twitter
|
||||||
icon: "fab fa-twitter"
|
icon: "fa-brands fa-x-twitter"
|
||||||
|
|
||||||
- type: email
|
- type: email
|
||||||
icon: "fas fa-envelope"
|
icon: "fas fa-envelope"
|
||||||
|
@ -3,7 +3,7 @@
|
|||||||
|
|
||||||
platforms:
|
platforms:
|
||||||
- type: Twitter
|
- type: Twitter
|
||||||
icon: "fab fa-twitter"
|
icon: "fa-brands fa-square-x-twitter"
|
||||||
link: "https://twitter.com/intent/tweet?text=TITLE&url=URL"
|
link: "https://twitter.com/intent/tweet?text=TITLE&url=URL"
|
||||||
|
|
||||||
- type: Facebook
|
- type: Facebook
|
||||||
|
@ -1 +1 @@
|
|||||||
Subproject commit 557de301fe393fb4660a338ae3c1b72ec2b3bf7c
|
Subproject commit 6737eab720e4cdd8330d32053053356f200d8819
|
Loading…
x
Reference in New Issue
Block a user