You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
When installing the [**Chirpy**][chirpy] theme through [RubyGems.org][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. If you have ever installed this theme gem, you can use the command `bundle info --path jekyll-theme-chirpy` to locate these files.
3
4
4
-
The startup template for [**Jekyll Theme Chirpy**][chirpy].
5
+
The Jekyll organization 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.
5
6
6
-
When installing the **Chirpy** theme 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. (You can find the gem files by using the command `bundle info --path jekyll-theme-chirpy`). To fully use all the features of **Chirpy**, you need to copy the other critical files/directories from the theme's gem to your Jekyll site.
7
-
8
-
The critical files/directories to run or build the **Chirpy** theme are as follows:
7
+
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:
9
8
10
9
```shell
11
10
.
11
+
├── _config.yml
12
12
├── _data
13
13
├── _plugins
14
14
├── _tabs
15
-
├── _config.yml
16
-
└── index.html
15
+
└── index.html
17
16
```
18
17
19
-
So we've extracted all the **Chirpy** gem necessary content here to help you get started quickly.
18
+
In order to save your time, and to prevent you from missing some files when 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.
19
+
20
+
## Prerequisites
21
+
22
+
Follow the instructions in the [Jekyll Docs](https://jekyllrb.com/docs/installation/) to complete the installation of `Ruby`, `RubyGems`, `Jekyll` and `Bundler`.
20
23
21
24
## Installation
22
25
23
-
[Use this template][usetemplate] to generate a new repository, and then execute:
26
+
[**Use this template**][use-template] to generate a brand new repository and name it `<GH_USERNAME>.github.io`, where `GH_USERNAME` represents your GitHub username.
Please see the [theme's docs](https://github.com/cotes2020/jekyll-theme-chirpy#usage).
34
37
35
-
## Upgrading
36
-
37
-
First, please modify the target version number of `jekyll-theme-chirpy` in the `Gemfile` (e.g., `gem "jekyll-theme-chirpy", "~> 4.0", ">= 4.0.1"`).
38
-
39
-
After that, execute the following command:
40
-
41
-
```console
42
-
$ bundle update jekyll-theme-chirpy
43
-
```
44
-
45
-
As the version upgrades, the critical files and configuration options will change. Please refer to the [Upgrade Guide](https://github.com/cotes2020/jekyll-theme-chirpy/wiki/Upgrade-Guide) to keep your website files in sync with the latest version of the theme.
0 commit comments