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
A minimal, sidebar, responsive web design Jekyll theme that focuses on text presentation. Designed to help you record and share your knowledge easily. [Live Demo »](https://chirpy.cotes.info)
Follow the [Jekyll Docs](https://jekyllrb.com/docs/installation/) to complete the installation of `Ruby`, `RubyGems`, `Jekyll` and `Bundler`.
58
+
Follow the [Jekyll Docs](https://jekyllrb.com/docs/installation/) to complete the installation of `Ruby`, `RubyGems`, `Jekyll` and `Bundler`. Please note that the version of `Ruby` must meet the requirements of the theme on [RubyGems.org](https://rubygems.org/gems/jekyll-theme-chirpy).
36
59
37
60
## Installation
38
61
39
62
There are two ways to get the theme:
40
63
41
-
-**Install from RubyGems** - Easy to update, isolate irrelevant project files so you can focus on writing.
42
-
-**Fork on GitHub** - Convenient for custom development, but difficult to update, only suitable for web developers.
64
+
-**[Install from RubyGems](#install-from-rubygems)** - Easy to update, isolate irrelevant project files so you can focus on writing.
65
+
-**[Fork on GitHub](#fork-on-github)** - Convenient for custom development, but difficult to update, only suitable for web developers.
43
66
44
-
### Installing the Theme Gem
67
+
### Install from RubyGems
45
68
46
69
Add this line to your Jekyll site's `Gemfile`:
47
70
@@ -61,15 +84,19 @@ And then execute:
61
84
$ bundle
62
85
```
63
86
64
-
Finally, copy the required files from the theme's gem (for detailed files, see [starter project][starter]) to your Jekyll site.
87
+
Next, go to the installed local theme path:
65
88
66
-
> **Hint**: To locate the installed theme’s gem, execute:
89
+
```console
90
+
$ cd"$(bundle info --path jekyll-theme-chirpy)"
91
+
```
92
+
93
+
And then copy the critical files (for details, see [starter project][starter]) from the theme's gem to your Jekyll site.
94
+
95
+
> ⚠️ **Watch out for duplicate files!**
67
96
>
68
-
> ```console
69
-
> $ bundle info --path jekyll-theme-chirpy
70
-
> ```
97
+
If your Jekyll site is created by the `jekyll new` command, there will be `index.markdown` and `about.markdown` in the root directory of your site. Please be sure to remove them, otherwise they will overwrite the `index.html` and `_tabs/about.html` from this project, resulting in blank or messy pages.
71
98
72
-
Or you can [**use the starter template**][use-starter] to create a Jekyll site to save time copying files from the theme's gem. We have prepared everything for you there!
99
+
As an alternative, which we recommend, you can create a Jekyll site [**using the starter template**][use-starter] to save time copying files from the theme's gem. We've prepared everything you need there!
73
100
74
101
### Fork on GitHub
75
102
@@ -111,6 +138,12 @@ Update the variables of `_config.yml` as needed. Some of them are typical option
111
138
-`timezone`
112
139
-`lang`
113
140
141
+
### Customing Stylesheet
142
+
143
+
If you need to customize stylesheet, copy the theme's `assets/css/style.scss` to the same path on your Jekyll site, and then add the custom style at the end of the style file.
144
+
145
+
Starting from `v4.1.0`, if you want to overwrite the SASS variables defined in `_sass/addon/variables.scss`, create a new file `_sass/variables-hook.scss` and assign new values to the target variable in it.
146
+
114
147
### Running Local Server
115
148
116
149
You may want to preview the site contents before publishing, so just run it by:
@@ -181,7 +214,7 @@ Unless you specified the output path, the generated site files will be placed in
181
214
182
215
## Documentation
183
216
184
-
For more details and a better reading experience, please check out the [tutorials on the demo site](https://chirpy.cotes.info/categories/tutorial/). In the meanwhile, a copy of the tutorial is also available on the [Wiki](https://github.com/cotes2020/jekyll-theme-chirpy/wiki).
217
+
For more details and a better reading experience, please check out the [tutorials on the demo site](https://chirpy.cotes.info/categories/tutorial/). In the meanwhile, a copy of the tutorial is also available on the [Wiki](https://github.com/cotes2020/jekyll-theme-chirpy/wiki). Please note that the tutorials on the demo website or Wiki are based on the latest release, and the features of `master` branch usually ahead of the documentation.
Copy file name to clipboardExpand all lines: _posts/2019-08-09-getting-started.md
+20-10Lines changed: 20 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,16 +9,16 @@ pin: true
9
9
10
10
## Prerequisites
11
11
12
-
Follow the [Jekyll Docs](https://jekyllrb.com/docs/installation/) to complete the installation of `Ruby`, `RubyGems`, `Jekyll` and `Bundler`.
12
+
Follow the [Jekyll Docs](https://jekyllrb.com/docs/installation/) to complete the installation of `Ruby`, `RubyGems`, `Jekyll` and `Bundler`. Please note that the version of `Ruby` must meet the requirements of the theme on [RubyGems.org](https://rubygems.org/gems/jekyll-theme-chirpy).
13
13
14
14
## Installation
15
15
16
16
There are two ways to get the theme:
17
17
18
-
-**Install from RubyGems** - Easy to update, isolate irrelevant project files so you can focus on writing.
19
-
-**Fork on GitHub** - Convenient for custom development, but difficult to update, only suitable for web developers.
18
+
-**[Install from RubyGems](#install-from-rubygems)** - Easy to update, isolate irrelevant project files so you can focus on writing.
19
+
-**[Fork on GitHub](#fork-on-github)** - Convenient for custom development, but difficult to update, only suitable for web developers.
20
20
21
-
### Installing the Theme Gem
21
+
### Install from RubyGems
22
22
23
23
Add this line to your Jekyll site's `Gemfile`:
24
24
@@ -38,15 +38,19 @@ And then execute:
38
38
$ bundle
39
39
```
40
40
41
-
Finally, copy the required files from the theme's gem (for detailed files, see [starter project][starter]) to your Jekyll site.
41
+
Next, go to the installed local theme path:
42
42
43
-
> **Hint**: To locate the installed theme’s gem, execute:
43
+
```console
44
+
$ cd"$(bundle info --path jekyll-theme-chirpy)"
45
+
```
46
+
47
+
And then copy the critical files (for details, see [starter project][starter]) from the theme's gem to your Jekyll site.
48
+
49
+
> ⚠️ **Watch out for duplicate files!**
44
50
>
45
-
> ```console
46
-
> $ bundle info --path jekyll-theme-chirpy
47
-
> ```
51
+
If your Jekyll site is created by the `jekyll new` command, there will be `index.markdown` and `about.markdown` in the root directory of your site. Please be sure to remove them, otherwise they will overwrite the `index.html` and `_tabs/about.html` from this project, resulting in blank or messy pages.
48
52
49
-
Or you can [**use the starter template**][use-starter] to create a Jekyll site to save time copying files from the theme's gem. We have prepared everything for you there!
53
+
As an alternative, which we recommend, you can create a Jekyll site [**using the starter template**][use-starter] to save time copying files from the theme's gem. We've prepared everything you need there!
50
54
51
55
### Fork on GitHub
52
56
@@ -88,6 +92,12 @@ Update the variables of `_config.yml` as needed. Some of them are typical option
88
92
-`timezone`
89
93
-`lang`
90
94
95
+
### Customing Stylesheet
96
+
97
+
If you need to customize stylesheet, copy the theme's `assets/css/style.scss` to the same path on your Jekyll site, and then add the custom style at the end of the style file.
98
+
99
+
Starting from `v4.1.0`, if you want to overwrite the SASS variables defined in `_sass/addon/variables.scss`, create a new file `_sass/variables-hook.scss` and assign new values to the target variable in it.
100
+
91
101
### Running Local Server
92
102
93
103
You may want to preview the site contents before publishing, so just run it by:
0 commit comments