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
Copy file name to clipboardExpand all lines: README.md
+13-9
Original file line number
Diff line number
Diff line change
@@ -21,16 +21,16 @@ A Jekyll theme with responsive web design that focuses on text presentation. Hop
21
21
* Google Analytics
22
22
* Pageviews (Advanced)
23
23
24
-
## Getting Startted
24
+
## Getting Started
25
25
26
26
### Preparation
27
27
28
-
Follow the [Jekyll Docs](https://jekyllrb.com/docs/installation/) to complete the installtion of basic environment (Ruby, RubyGem, Bundler and Jekyll). In addition, to use the funny script tools, we also need to install [Python](https://www.python.org/downloads/)(version 3.5 or abover), [ruamel.yaml](https://pypi.org/project/ruamel.yaml/) and [fswatch](http://emcrisostomo.github.io/fswatch/getting.html).
28
+
Follow the [Jekyll Docs](https://jekyllrb.com/docs/installation/) to complete the installtion of basic environment (Ruby, RubyGem, Bundler and Jekyll). In addition, to use the funny script tools, we also need to install [Python](https://www.python.org/downloads/)(version 3.5 or abover) and [ruamel.yaml](https://pypi.org/project/ruamel.yaml/).
29
29
30
-
Next, [fork Chirpy](https://github.com/cotes2020/jekyll-theme-chirpy/fork) and then clone the replicated repository locally.
30
+
Next, [fork](https://github.com/cotes2020/jekyll-theme-chirpy/fork)**Chirpy**and then clone your replicated repository locally.
31
31
32
32
33
-
### Install Jekyll plugins
33
+
### Install Jekyll Plugins
34
34
35
35
Go to root directory of the repository and run the following:
36
36
@@ -41,7 +41,7 @@ $ bundle install
41
41
`bundle` will install all the dependent Jekyll Plugins listed in file `Gemfile` automatically.
42
42
43
43
44
-
### File structure
44
+
### File Structure
45
45
46
46
The main files and related brief introductions are listed below.
47
47
@@ -90,16 +90,20 @@ The Atom feed url of your site will be:
90
90
The `SITE_URL` was defined by variable `url` in file `_config.yml`.
91
91
92
92
93
-
### Run locally
93
+
### Run Locally
94
94
95
95
You may want to preview the site before publishing, so just run the script tool:
96
96
97
97
```terminal
98
98
$ bash run.sh
99
99
```
100
-
>**Note**: Because the *Recent Update* required the latest git-log date of posts, so make sure the changes of `_posts` have been committed before running this command.
101
100
102
-
Open a brower and visit <http://127.0.0.1:4000>
101
+
>**Note**: The *Recent Update* list requires the latest git-log date of posts, thus make sure the changes in `_posts` have been committed before running this command.
102
+
103
+
Open a brower and visit <http://localhost:4000>.
104
+
105
+
Few days later, you may find that the file changes does not refresh in real time by using `run.sh`. Don't worry, the advanced option `-r` (or `--realtime`) will solve this problem, but it requires [**fswatch**](http://emcrisostomo.github.io/fswatch/) to be installed on your machine.
106
+
103
107
104
108
### Deploying to GitHub Pages
105
109
@@ -126,7 +130,7 @@ It will automatically generates the *Latest Modified Date* and *Categories / Tag
126
130
**4**. Visit `https://<username>.github.io` and enjoy.
127
131
128
132
129
-
#### Option 2: Build locally
133
+
#### Option 2: Build Locally
130
134
131
135
For security reasons, GitHub Pages runs on `safe` mode, which means the third-party Jekyll plugins or custom scripts will not work. If you want to use any another third-party Jekyll plugins, **your have to build locally rather than on GitHub Pages**.
Copy file name to clipboardExpand all lines: _posts/2019-08-09-getting-started.md
+12-9
Original file line number
Diff line number
Diff line change
@@ -1,18 +1,18 @@
1
1
---
2
-
title: Getting started
2
+
title: Getting Started
3
3
date: 2019-08-09 20:55:00 +0800
4
4
categories: [Blogging, Tutorial]
5
5
tags: [getting started]
6
6
---
7
7
8
8
## Preparation
9
9
10
-
Follow the [Jekyll Docs](https://jekyllrb.com/docs/installation/) to complete the installtion of basic environment (Ruby, RubyGem, Bundler and Jekyll). In addition, to use the funny script tools, we also need to install [Python](https://www.python.org/downloads/)(version 3.5 or abover), [ruamel.yaml](https://pypi.org/project/ruamel.yaml/) and [fswatch](http://emcrisostomo.github.io/fswatch/getting.html).
10
+
Follow the [Jekyll Docs](https://jekyllrb.com/docs/installation/) to complete the installtion of basic environment (Ruby, RubyGem, Bundler and Jekyll). In addition, to use the funny script tools, we also need to install [Python](https://www.python.org/downloads/)(version 3.5 or abover) and [ruamel.yaml](https://pypi.org/project/ruamel.yaml/).
11
11
12
-
Next, [fork Chirpy](https://github.com/cotes2020/jekyll-theme-chirpy/fork) and then clone the replicated repository locally.
12
+
Next, [fork](https://github.com/cotes2020/jekyll-theme-chirpy/fork)**Chirpy**and then clone your replicated repository locally.
13
13
14
14
15
-
## Install Jekyll plugins
15
+
## Install Jekyll Plugins
16
16
17
17
Go to root directory of the repository and run the following:
18
18
@@ -23,7 +23,7 @@ $ bundle install
23
23
`bundle` will install all the dependent Jekyll Plugins listed in file `Gemfile` automatically.
24
24
25
25
26
-
## File structure
26
+
## File Structure
27
27
28
28
The main files and related brief introductions are listed below.
29
29
@@ -72,16 +72,19 @@ The Atom feed url of your site will be:
72
72
The `SITE_URL` was defined by variable `url` in file `_config.yml`.
73
73
74
74
75
-
## Run locally
75
+
## Run Locally
76
76
77
77
You may want to preview the site before publishing, so just run the script tool:
78
78
79
79
```terminal
80
80
$ bash run.sh
81
81
```
82
-
>**Note**: Because the *Recent Update* required the latest git-log date of posts, so make sure the changes of `_posts` have been committed before running this command.
83
82
84
-
Open a brower and visit <http://127.0.0.1:4000>
83
+
>**Note**: The *Recent Update* list requires the latest git-log date of posts, thus make sure the changes in `_posts` have been committed before running this command.
84
+
85
+
Open a brower and visit <http://localhost:4000>.
86
+
87
+
Few days later, you may find that the file changes does not refresh in real time by using `run.sh`. Don't worry, the advanced option `-r` (or `--realtime`) will solve this problem, but it requires [**fswatch**](http://emcrisostomo.github.io/fswatch/) to be installed on your machine.
85
88
86
89
## Deploying to GitHub Pages
87
90
@@ -108,7 +111,7 @@ It will automatically generates the *Latest Modified Date* and *Categories / Tag
108
111
**4**. Visit `https://<username>.github.io` and enjoy.
109
112
110
113
111
-
### Option 2: Build locally
114
+
### Option 2: Build Locally
112
115
113
116
For security reasons, GitHub Pages runs on `safe` mode, which means the third-party Jekyll plugins or custom scripts will not work. If you want to use any another third-party Jekyll plugins, **your have to build locally rather than on GitHub Pages**.
0 commit comments