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
If you would like to run or build the project on your local machine, please follow the [Jekyll Docs](https://jekyllrb.com/docs/installation/) to complete the installation of `Ruby`, `RubyGems` and `Bundler`.
51
+
If you would like to run or build the project on your local machine, please follow the [Jekyll Docs](https://jekyllrb.com/docs/installation/) to complete the installation of `Ruby`, `RubyGems` and `Bundler`.
53
52
54
53
Before running or building for the first time, please complete the installation of the Jekyll plugins. Go to the root directory of project and run:
55
54
@@ -61,19 +60,18 @@ $ bundle install
61
60
62
61
What's more, in order to generate some extra files (*categories*, *tags* and *last modified list*), we need to use some tool scripts. If your machine is running Debian or macOS, make sure that [GNU coreutils](https://www.gnu.org/software/coreutils/) is installed. Otherwise, install by:
63
62
64
-
* Debian
63
+
- Debian
65
64
66
65
```console
67
66
$ sudo apt-get install coreutils
68
67
```
69
68
70
-
* macOS
69
+
- macOS
71
70
72
71
```console
73
72
$ brew install coreutils
74
73
```
75
74
76
-
77
75
## Usage
78
76
79
77
Running [**Chirpy**](https://github.com/cotes2020/jekyll-theme-chirpy/) requires some extra files, which cannot be generated by Jekyll native commands, so please strictly follow the methods mentioned below to run or deploy your website.
@@ -91,23 +89,23 @@ $ bash tools/init.sh
91
89
What it does is:
92
90
93
91
1. Remove some files or directories from your repository:
94
-
* `.travis.yml`
95
-
* files under `_posts`
96
-
* folder `docs`
97
92
98
-
2. If you use the `--no-gh` option, the directory `.github` will be deleted. Otherwise, setup the GitHub Action workflow by removing extension `.hook` of `.github/workflows/pages-deploy.yml.hook`, and then remove the other files and directories in folder `.github`.
93
+
-`.travis.yml`
94
+
- files under `_posts`
95
+
- folder `docs`
96
+
97
+
2. If you use the `--no-gh` option, the directory `.github` will be deleted. Otherwise, setup the GitHub Action workflow by removing extension `.hook` of `.github/workflows/pages-deploy.yml.hook`, and then remove the other files and directories in folder `.github`.
99
98
100
99
3. Automatically create a commit to save the changes.
101
100
102
101
### Configuration
103
102
104
103
Generally, go to `_config.yml` and configure the variables as needed. Some of them are typical options:
105
104
106
-
*`url`
107
-
*`avatar`
108
-
*`timezone`
109
-
*`theme_mode`
110
-
105
+
-`url`
106
+
-`avatar`
107
+
-`timezone`
108
+
-`theme_mode`
111
109
112
110
### Run Locally
113
111
@@ -177,19 +175,16 @@ For more details and the better reading experience, please check out the [tutori
177
175
178
176
The old saying, "Two heads are better than one." Consequently, welcome to report bugs, improve code quality or submit a new feature. For more information, see [contributing guidelines](.github/CONTRIBUTING.md).
179
177
180
-
181
178
## Credits
182
179
183
180
This theme is mainly built with [Jekyll](https://jekyllrb.com/) ecosystem, [Bootstrap](https://getbootstrap.com/), [Font Awesome](https://fontawesome.com/) and some other wonderful tools (their copyright information can be found in the relevant files).
184
181
185
182
:tada: Thanks to all the volunteers who contributed to this project, their GitHub IDs are on [this list](https://github.com/cotes2020/jekyll-theme-chirpy/graphs/contributors). Also, I won't forget those guys who submitted the issues or unmerged PR because they reported bugs, shared ideas or inspired me to write more readable documentation.
186
183
187
-
188
184
## Support
189
185
190
186
If you enjoy this theme or find it helpful, please consider becoming my sponsor, I'd really appreciate it! Click the button <kbd>:heart: Sponsor</kbd> at the top of the [Home Page](https://github.com/cotes2020/jekyll-theme-chirpy) and choose a link that suits you to donate; this will encourage and help me better maintain the project.
191
187
192
-
193
188
## License
194
189
195
190
This work is published under [MIT](https://github.com/cotes2020/jekyll-theme-chirpy/blob/master/LICENSE) License.
Copy file name to clipboardExpand all lines: _posts/2019-08-09-getting-started.md
+13-9
Original file line number
Diff line number
Diff line change
@@ -30,13 +30,13 @@ $ bundle install
30
30
31
31
What's more, in order to generate some extra files (*categories*, *tags* and *last modified list*), we need to use some tool scripts. If your machine is running Debian or macOS, make sure that [GNU coreutils](https://www.gnu.org/software/coreutils/) is installed. Otherwise, install by:
32
32
33
-
* Debian
33
+
- Debian
34
34
35
35
```console
36
36
$ sudo apt-get install coreutils
37
37
```
38
38
39
-
* macOS
39
+
- macOS
40
40
41
41
```console
42
42
$ brew install coreutils
@@ -59,19 +59,23 @@ $ bash tools/init.sh
59
59
What it does is:
60
60
61
61
1. Remove some files or directories from your repository:
62
-
*`.travis.yml`
63
-
* files under `_posts`
64
-
* folder `docs`
62
+
63
+
-`.travis.yml`
64
+
- files under `_posts`
65
+
- folder `docs`
66
+
65
67
2. If you use the `--no-gh` option, the directory `.github` will be deleted. Otherwise, setup the GitHub Action workflow by removing extension `.hook` of `.github/workflows/pages-deploy.yml.hook`, and then remove the other files and directories in folder `.github`.
68
+
66
69
3. Automatically create a commit to save the changes.
67
70
68
71
### Configuration
69
72
70
73
Generally, go to `_config.yml` and configure the variables as needed. Some of them are typical options:
0 commit comments