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.
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.
6
+
When installing the [**Chirpy**][chirpy] theme through [RubyGems.org][gem], Jekyll can only read files in the folders
7
+
`_data`, `_layouts`, `_includes`, `_sass` and `assets`, as well as a small part of options of the `_config.yml` file
8
+
from the theme's gem. If you have ever installed this theme gem, you can use the command
9
+
`bundle info --path jekyll-theme-chirpy` to locate these files.
6
10
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:
11
+
The Jekyll team claims that this is to leave the ball in the user’s court, but this also results in users not being
12
+
able to enjoy the out-of-the-box experience when using feature-rich themes.
13
+
14
+
To fully use all the features of **Chirpy**, you need to copy the other critical files from the theme's gem to your
15
+
Jekyll site. The following is a list of targets:
8
16
9
17
```shell
10
18
.
11
19
├── _config.yml
12
-
├── _data
13
20
├── _plugins
14
21
├── _tabs
15
22
└── index.html
16
23
```
17
24
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.
25
+
To save you time, and also in case you lose some files while copying, we extract those files/configurations of the
26
+
latest version of the **Chirpy** theme and the [CD][CD] workflow to here, so that you can start writing in minutes.
19
27
20
28
## Prerequisites
21
29
22
-
Follow the instructions in the [Jekyll Docs](https://jekyllrb.com/docs/installation/) to complete the installation of `Ruby`, `RubyGems`, `Jekyll` and `Bundler`.
30
+
Follow the instructions in the [Jekyll Docs](https://jekyllrb.com/docs/installation/) to complete the installation of
31
+
the basic environment. [Git](https://git-scm.com/) also needs to be installed.
23
32
24
33
## Installation
25
34
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.
35
+
Sign in to GitHub and [**use this template**][use-template] to generate a brand new repository and name it
36
+
`USERNAME.github.io`, where `USERNAME` represents your GitHub username.
27
37
28
38
Then clone it to your local machine and run:
29
39
30
-
```
40
+
```console
31
41
$ bundle
32
42
```
33
43
@@ -43,4 +53,4 @@ This work is published under [MIT][mit] License.
0 commit comments