Skip to content

Commit 7f13e01

Browse files
committed
Update Docs.
1 parent 58aa08d commit 7f13e01

File tree

5 files changed

+38
-41
lines changed

5 files changed

+38
-41
lines changed

.github/ISSUE_TEMPLATE/question.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,12 +15,8 @@ labels: question
1515

1616

1717
## I don't understand what the ReadMe/Wiki says
18-
<!--
19-
Point out the parts that are hard for you to understand.
20-
-->
18+
<!-- Point out the parts that are hard for you to understand. -->
2119

2220

2321
## I have other questions
24-
<!--
25-
Please describe your question.
26-
-->
22+
<!-- Please describe your question. -->

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,12 @@
1-
# Description
1+
## Description
22

33
<!--
44
Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.
55
-->
66

7-
Fixes #(issue)
7+
e.g. Fixes #(issue)
88

9-
10-
## Type of change
9+
**Type of change**
1110

1211
<!--
1312
Please select the desired item checkbox and change it to "[x]", then delete options that are not relevant.
@@ -17,7 +16,7 @@ Please select the desired item checkbox and change it to "[x]", then delete opti
1716
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
1817
- [ ] Documentation update
1918

20-
# How Has This Been Tested?
19+
## How has this been tested?
2120

2221
<!--
2322
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
@@ -26,7 +25,7 @@ Please describe the tests that you ran to verify your changes. Provide instructi
2625
- [ ] I have run `bash ./tools/build.sh && bash ./tools/test.sh` (at the root of the project) locally and passed
2726
- [ ] I have tested this feature in the browser
2827

29-
## Test Configuration
28+
**Test Configuration**
3029

3130
* Browerser type & version:
3231
* Operating system:
@@ -35,7 +34,7 @@ Please describe the tests that you ran to verify your changes. Provide instructi
3534
* Jekyl version:
3635

3736

38-
# Checklist:
37+
## Checklist:
3938
<!-- Select checkboxes by change the "[ ]" to "[x]" -->
4039
- [ ] My code follows the [Google style guidelines](https://google.github.io/styleguide/)
4140
- [ ] I have performed a self-review of my own code

README.md

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -47,15 +47,15 @@ To improve the writing experience, we need to use some script tools. If your mac
4747

4848
* Debian
4949

50-
```console
51-
$ sudo apt-get install coreutils
52-
```
50+
```console
51+
$ sudo apt-get install coreutils
52+
```
5353

5454
* macOS
5555

56-
```console
57-
$ brew install coreutils
58-
```
56+
```console
57+
$ brew install coreutils
58+
```
5959

6060

6161
### Jekyll Plugins
@@ -66,7 +66,7 @@ $ brew install coreutils
6666
$ git clone git@github.com:USER/jekyll-theme-chirpy.git -b master
6767
```
6868

69-
and replace the `USER` above to your GitHub username.
69+
And replace the `USER` above to your GitHub username.
7070

7171
The first time you run or build the project on local machine, perform the installation of Jekyll plugins. Go to the root of repo and run:
7272

@@ -82,7 +82,7 @@ $ bundle install
8282

8383
### Directory Structure
8484

85-
The main files and related brief introductions are listed below.
85+
The main files and related brief introductions are listed below:
8686

8787
```sh
8888
jekyll-theme-chirpy/
@@ -113,8 +113,9 @@ jekyll-theme-chirpy/
113113

114114
As mentioned above, some files or directories should be removed from your repo:
115115

116-
- .travis.yml
117-
- .github
116+
```terminal
117+
$ rm -rf .travis.yml .github _posts/*
118+
```
118119

119120

120121
### Configuration
@@ -164,7 +165,7 @@ Before the deployment begins, checkout the file `_config.yml` and make sure that
164165

165166
By deploying the site in this way, you're allowed to push the source code directly to the remote.
166167

167-
> **Note**: If you want to use any third-party Jekyll plugins that not in [this list](https://pages.github.com/versions/), stop reading the current approach and go to [*Option 2: Build locally*](#option-2-build-locally).
168+
> **Note**: If you want to use any third-party Jekyll plugins that not on [this list](https://pages.github.com/versions/), stop reading the current approach and go to [*Option 2: Build locally*](#option-2-build-locally).
168169
169170
**1**. Rename the repository to:
170171

@@ -202,7 +203,7 @@ it will automatically generates the *Latest Modified Date* and *Categories / Tag
202203

203204
#### Option 2: Build Locally
204205

205-
For security reasons, GitHub Pages runs on `safe` mode, which means the third-party Jekyll plugins or custom scripts won't work. If you want to use any another plugins that not in the [whitelist](https://pages.github.com/versions/), **you have to generate the site locally rather than on GitHub Pages**.
206+
For security reasons, GitHub Pages runs on `safe` mode, which means the third-party Jekyll plugins or custom scripts won't work. If you want to use any other plugin that not on the [whitelist](https://pages.github.com/versions/), **you have to generate the site locally rather than on GitHub Pages**.
206207

207208
**1**. Browse to GitHub website, create a brand new repo named:
208209

_posts/2019-08-09-getting-started.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -15,15 +15,15 @@ To improve the writing experience, we need to use some script tools. If your mac
1515

1616
* Debian
1717

18-
```console
19-
$ sudo apt-get install coreutils
20-
```
18+
```console
19+
$ sudo apt-get install coreutils
20+
```
2121

2222
* macOS
2323

24-
```console
25-
$ brew install coreutils
26-
```
24+
```console
25+
$ brew install coreutils
26+
```
2727

2828

2929
## Jekyll Plugins
@@ -34,7 +34,7 @@ $ brew install coreutils
3434
$ git clone git@github.com:USER/jekyll-theme-chirpy.git -b master
3535
```
3636

37-
and replace the `USER` above to your GitHub username.
37+
And replace the `USER` above to your GitHub username.
3838

3939
The first time you run or build the project on local machine, perform the installation of Jekyll plugins. Go to the root of repo and run:
4040

@@ -47,7 +47,7 @@ $ bundle install
4747

4848
## Directory Structure
4949

50-
The main files and related brief introductions are listed below.
50+
The main files and related brief introductions are listed below:
5151

5252
```sh
5353
jekyll-theme-chirpy/
@@ -77,9 +77,9 @@ jekyll-theme-chirpy/
7777

7878
As mentioned above, some files or directories should be removed from your repo:
7979

80-
- .travis.yml
81-
- .github
82-
80+
```terminal
81+
$ rm -rf .travis.yml .github _posts/*
82+
```
8383

8484
## Configuration
8585

@@ -129,7 +129,7 @@ Before the deployment begins, checkout the file `_config.yml` and make sure that
129129

130130
By deploying the site in this way, you're allowed to push the source code directly to the remote.
131131

132-
> **Note**: If you want to use any third-party Jekyll plugins that not in [this list](https://pages.github.com/versions/), stop reading the current approach and go to [*Option 2: Build locally*](#option-2-build-locally).
132+
> **Note**: If you want to use any third-party Jekyll plugins that not on [this list](https://pages.github.com/versions/), stop reading the current approach and go to [*Option 2: Build locally*](#option-2-build-locally).
133133
134134
**1**. Rename the repository to:
135135

@@ -167,7 +167,7 @@ it will automatically generates the *Latest Modified Date* and *Categories / Tag
167167

168168
### Option 2: Build Locally
169169

170-
For security reasons, GitHub Pages runs on `safe` mode, which means the third-party Jekyll plugins or custom scripts won't work. If you want to use any another plugins that not in the [whitelist](https://pages.github.com/versions/), **you have to generate the site locally rather than on GitHub Pages**.
170+
For security reasons, GitHub Pages runs on `safe` mode, which means the third-party Jekyll plugins or custom scripts won't work. If you want to use any other plugin that not on the [whitelist](https://pages.github.com/versions/), **you have to generate the site locally rather than on GitHub Pages**.
171171

172172
**1**. Browse to GitHub website, create a brand new repo named:
173173

docs/README_zh-CN.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -114,10 +114,11 @@ jekyll-theme-chirpy/
114114
```
115115

116116

117-
你需要将以下文件或目录删除:
117+
如备注所述,部分文件或目录需要被删除:
118118

119-
- .travis.yml
120-
- .github
119+
```terminal
120+
$ rm -rf .travis.yml .github _posts/*
121+
```
121122

122123

123124
### 配置文件

0 commit comments

Comments
 (0)