Skip to content

Commit 1be138e

Browse files
committed
Update Docs.
1 parent 10d0d3e commit 1be138e

File tree

2 files changed

+25
-18
lines changed

2 files changed

+25
-18
lines changed

Diff for: README.md

+13-9
Original file line numberDiff line numberDiff line change
@@ -21,16 +21,16 @@ A Jekyll theme with responsive web design that focuses on text presentation. Hop
2121
* Google Analytics
2222
* Pageviews (Advanced)
2323

24-
## Getting Startted
24+
## Getting Started
2525

2626
### Preparation
2727

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/).
2929

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.
3131

3232

33-
### Install Jekyll plugins
33+
### Install Jekyll Plugins
3434

3535
Go to root directory of the repository and run the following:
3636

@@ -41,7 +41,7 @@ $ bundle install
4141
`bundle` will install all the dependent Jekyll Plugins listed in file `Gemfile` automatically.
4242

4343

44-
### File structure
44+
### File Structure
4545

4646
The main files and related brief introductions are listed below.
4747

@@ -90,16 +90,20 @@ The Atom feed url of your site will be:
9090
The `SITE_URL` was defined by variable `url` in file `_config.yml`.
9191

9292

93-
### Run locally
93+
### Run Locally
9494

9595
You may want to preview the site before publishing, so just run the script tool:
9696

9797
```terminal
9898
$ bash run.sh
9999
```
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.
101100

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+
103107

104108
### Deploying to GitHub Pages
105109

@@ -126,7 +130,7 @@ It will automatically generates the *Latest Modified Date* and *Categories / Tag
126130
**4**. Visit `https://<username>.github.io` and enjoy.
127131

128132

129-
#### Option 2: Build locally
133+
#### Option 2: Build Locally
130134

131135
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**.
132136

Diff for: _posts/2019-08-09-getting-started.md

+12-9
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
---
2-
title: Getting started
2+
title: Getting Started
33
date: 2019-08-09 20:55:00 +0800
44
categories: [Blogging, Tutorial]
55
tags: [getting started]
66
---
77

88
## Preparation
99

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/).
1111

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.
1313

1414

15-
## Install Jekyll plugins
15+
## Install Jekyll Plugins
1616

1717
Go to root directory of the repository and run the following:
1818

@@ -23,7 +23,7 @@ $ bundle install
2323
`bundle` will install all the dependent Jekyll Plugins listed in file `Gemfile` automatically.
2424

2525

26-
## File structure
26+
## File Structure
2727

2828
The main files and related brief introductions are listed below.
2929

@@ -72,16 +72,19 @@ The Atom feed url of your site will be:
7272
The `SITE_URL` was defined by variable `url` in file `_config.yml`.
7373

7474

75-
## Run locally
75+
## Run Locally
7676

7777
You may want to preview the site before publishing, so just run the script tool:
7878

7979
```terminal
8080
$ bash run.sh
8181
```
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.
8382

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.
8588

8689
## Deploying to GitHub Pages
8790

@@ -108,7 +111,7 @@ It will automatically generates the *Latest Modified Date* and *Categories / Tag
108111
**4**. Visit `https://<username>.github.io` and enjoy.
109112

110113

111-
### Option 2: Build locally
114+
### Option 2: Build Locally
112115

113116
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**.
114117

0 commit comments

Comments
 (0)