Skip to content

Commit 13e1fd8

Browse files
committed
Improve docs
1 parent f0b9150 commit 13e1fd8

File tree

3 files changed

+11
-11
lines changed

3 files changed

+11
-11
lines changed

Diff for: README.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
# Chirpy
22

3-
🌏 English [简体中文](docs/README_zh-CN.md)
3+
Language: English | [简体中文](docs/README_zh-CN.md)
44

55
[![Build Status](https://github.com/cotes2020/jekyll-theme-chirpy/workflows/build/badge.svg?branch=master&event=push)](https://github.com/cotes2020/jekyll-theme-chirpy/actions?query=branch%3Amaster+event%3Apush)
66
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/8220b926db514f13afc3f02b7f884f4b)](https://app.codacy.com/manual/cotes2020/jekyll-theme-chirpy?utm_source=github.com&utm_medium=referral&utm_content=cotes2020/jekyll-theme-chirpy&utm_campaign=Badge_Grade_Dashboard)
77
[![GitHub license](https://img.shields.io/github/license/cotes2020/jekyll-theme-chirpy.svg)](https://github.com/cotes2020/jekyll-theme-chirpy/blob/master/LICENSE)
88
[![996.icu](https://img.shields.io/badge/link-996.icu-%23FF4D5B.svg)](https://996.icu)
99

10-
A minimal, sidebar, responsive web design Jekyll theme, focusing on text presentation, aim to help you easily record and share your knowledge. [Live Demo »](https://chirpy.cotes.info)
10+
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)
1111

1212
[![Devices Mockup](https://raw.githubusercontent.com/cotes2020/jekyll-theme-chirpy/master/assets/img/sample/devices-mockup.png)](https://chirpy.cotes.info)
1313

@@ -18,7 +18,7 @@ A minimal, sidebar, responsive web design Jekyll theme, focusing on text present
1818
- [Usage](#usage)
1919
- [Contributing](#contributing)
2020
- [Credits](#credits)
21-
- [Support](#support)
21+
- [Supporting](#supporting)
2222
- [License](#license)
2323

2424
## Features
@@ -48,7 +48,7 @@ $ git clone https://github.com/USERNAME/USERNAME.github.io.git -b master --singl
4848

4949
### Setting up the local envrionment
5050

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`.
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`, `Jekyll` and `Bundler`.
5252

5353
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:
5454

@@ -86,7 +86,7 @@ What it does is:
8686
- files under `_posts`
8787
- folder `docs`
8888

89-
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`.
89+
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`.
9090

9191
3. Automatically create a commit to save the changes.
9292

@@ -132,7 +132,7 @@ For security reasons, GitHub Pages build runs on `safe` mode, which restricts us
132132

133133
1. Push any commit to `origin/master` to trigger the GitHub Actions workflow. Once the build is complete and successful, a new remote branch named `gh-pages` will appear to store the built site files.
134134

135-
2. Browse to your repository on GitHub and choose the branch `gh-pages` as the [publishing source](https://docs.github.com/en/github/working-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site) throught _Settings__Options__GitHub Pages_:
135+
2. Browse to your repo's landing page on GitHub and select the branch `gh-pages` as the [publishing source](https://docs.github.com/en/github/working-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site) throught _Settings__Options__GitHub Pages_:
136136
![gh-pages-sources](https://raw.githubusercontent.com/cotes2020/jekyll-theme-chirpy/master/assets/img/sample/gh-pages-sources.png)
137137

138138
3. Visit your website at the address indicated by GitHub.
@@ -173,7 +173,7 @@ This theme is mainly built with [Jekyll](https://jekyllrb.com/) ecosystem, [Boot
173173

174174
: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.
175175

176-
## Support
176+
## Supporting
177177

178178
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.
179179

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ $ git clone https://github.com/USERNAME/USERNAME.github.io.git -b master --singl
1818

1919
### Setting up the local envrionment
2020

21-
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`.
21+
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`, `Jekyll` and `Bundler`.
2222

2323
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:
2424

@@ -103,7 +103,7 @@ For security reasons, GitHub Pages build runs on `safe` mode, which restricts us
103103

104104
1. Push any commit to `origin/master` to trigger the GitHub Actions workflow. Once the build is complete and successful, a new remote branch named `gh-pages` will appear to store the built site files.
105105

106-
2. Browse to your repository on GitHub and choose the branch `gh-pages` as the [publishing source](https://docs.github.com/en/github/working-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site) throught _Settings__Options__GitHub Pages_:
106+
2. Browse to your repo's landing page on GitHub and select the branch `gh-pages` as the [publishing source](https://docs.github.com/en/github/working-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site) throught _Settings__Options__GitHub Pages_:
107107
![gh-pages-sources](/assets/img/sample/gh-pages-sources.png){: width="650" class="normal"}
108108

109109
3. Visit your website at the address indicated by GitHub.

Diff for: docs/README_zh-CN.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Chirpy
22

3-
🌏 [English](../README.md) 简体中文
3+
Language: [English](../README.md) | 简体中文
44

55
[![Build Status](https://github.com/cotes2020/jekyll-theme-chirpy/workflows/build/badge.svg?branch=master&event=push)](https://github.com/cotes2020/jekyll-theme-chirpy/actions?query=branch%3Amaster+event%3Apush)
66
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/8220b926db514f13afc3f02b7f884f4b)](https://app.codacy.com/manual/cotes2020/jekyll-theme-chirpy?utm_source=github.com&utm_medium=referral&utm_content=cotes2020/jekyll-theme-chirpy&utm_campaign=Badge_Grade_Dashboard)
@@ -51,7 +51,7 @@ $ git clone https://github.com/USERNAME/USERNAME.github.io.git -b master --singl
5151

5252
### 设置本地环境
5353

54-
如果你想在本地运行或构建, 参考 [Jekyll Docs](https://jekyllrb.com/docs/installation/)安装 `Ruby` `RubyGems``Bundler`
54+
如果你想在本地运行或构建, 参考 [Jekyll Docs](https://jekyllrb.com/docs/installation/)安装 `Ruby``RubyGems``Jekyll``Bundler`
5555

5656
首次运行或构建时, 请先安装 Jekyll plugins。在项目根目录运行:
5757

0 commit comments

Comments
 (0)