Skip to content

Commit dad85d1

Browse files
committed
Fixed tutorial.
1 parent 293dedd commit dad85d1

File tree

3 files changed

+8
-14
lines changed

3 files changed

+8
-14
lines changed

Diff for: README.md

+4-6
Original file line numberDiff line numberDiff line change
@@ -30,15 +30,15 @@ You will get the following features:
3030

3131
## Table of Contents
3232

33-
* [Getting Started](#getting-started)
33+
* [Installing](#installing)
3434
* [Usage](#usage)
3535
* [Contributing](#contributing)
3636
* [Credits](#credits)
3737
* [Support](#support)
3838
* [License](#license)
3939

4040

41-
## Getting Started
41+
## Installing
4242

4343
### Prerequisites
4444

@@ -59,7 +59,7 @@ $ brew install coreutils
5959
```
6060

6161

62-
### Installing
62+
### Jekyll Plugins
6363

6464
[Fork **Chirpy** from GitHub](https://github.com/cotes2020/jekyll-theme-chirpy/fork), then clone your forked repo to local:
6565

@@ -147,7 +147,7 @@ Few days later, you may find that the file modification(e.g. edits to a post) do
147147

148148
### Deploying to GitHub Pages
149149

150-
Before the deployment begins, ensure the `url` in file `_config.yml` has been set to `https://<username>.github.io`(or the custom domain, if you have. e.g. `https://yourdomain.com`).
150+
Before the deployment begins, ensure the `url` in file `_config.yml` has been set to `https://<username>.github.io`(or the custom domain, if you have. e.g. `https://yourdomain.com`). What's more, if you prefer to the [Project site](https://help.github.com/en/github/working-with-github-pages/about-github-pages#types-of-github-pages-sites), change `baseurl` of file `_config.yml` to your project name, starting with a slash. e.g. `/project`.
151151

152152
#### Option 1: Built by GitHub Pages
153153

@@ -201,8 +201,6 @@ and clone it.
201201
$ bash tools/build.sh -d /path/to/local/project/
202202
```
203203

204-
If you prefer to the Project site, change `baseurl` of file `_config.yml` to your project name, starting with a slash. e.g. `/project`. Or, simply add argument `-b /project` behide the command above.
205-
206204
The generated static files will be placed in the root of `/path/to/local/project`. Commit and push the changes to the `master` branch on GitHub.
207205

208206
**3**. Go to GitHub website and enable Pages service for the new repository.

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

+1-3
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ Few days later, you may find that the file changes does not refresh in real time
100100

101101
## Deploying to GitHub Pages
102102

103-
Before the deployment begins, ensure the `url` in file `_config.yml` has been set to `https://<username>.github.io`(or the custom domain, if you have. e.g. `https://yourdomain.com`).
103+
Before the deployment begins, ensure the `url` in file `_config.yml` has been set to `https://<username>.github.io`(or the custom domain, if you have. e.g. `https://yourdomain.com`). What's more, if you prefer to the [Project site](https://help.github.com/en/github/working-with-github-pages/about-github-pages#types-of-github-pages-sites), change `baseurl` of file `_config.yml` to your project name, starting with a slash. e.g. `/project`.
104104

105105

106106
### Option 1: Built by GitHub Pages
@@ -155,8 +155,6 @@ and clone it.
155155
$ bash tools/build.sh -d /path/to/local/project/
156156
```
157157

158-
> If you prefer to the Project site, change `baseurl` of file `_config.yml` to your project name, starting with a slash. e.g. `/project`. Or, simply add argument `-b /project` behide the command above.
159-
160158
The generated static files will be placed in the root of `/path/to/local/project`. Commit and push the changes to the `master` branch on GitHub.
161159

162160
**3**. Go to GitHub website and enable Pages service for the new repository.

Diff for: docs/README_zh-CN.md

+3-5
Original file line numberDiff line numberDiff line change
@@ -30,14 +30,14 @@ Language: [English](../README.md) | 简体中文
3030

3131
## 目录
3232

33-
* [开始](#开始)
33+
* [安装](#安装)
3434
* [运行指南](#运行指南)
3535
* [参与贡献](#参与贡献)
3636
* [感谢](#感谢)
3737
* [赞助](#赞助)
3838
* [许可证书](#许可证书)
3939

40-
## 开始
40+
## 安装
4141

4242
### 准备工作
4343

@@ -146,7 +146,7 @@ $ bash tools/run.sh
146146

147147
### 部署到 GitHub Pages
148148

149-
部署开始前,把 `_config.yml``url` 改为 `https://<username>.github.io`(或者你的私有域名,如:`https://yourdomain.com`).
149+
部署开始前,把 `_config.yml``url` 改为 `https://<username>.github.io`(或者你的私有域名,如:`https://yourdomain.com`)。另外,如果你想使用 [Project 类型网站](https://help.github.com/en/github/working-with-github-pages/about-github-pages#types-of-github-pages-sites),修改配置文件的 `baseurl` 为项目名称,以斜杠开头,如:`/project`
150150

151151
#### 方法 1: 由 GitHub Pages 生成站点
152152

@@ -201,8 +201,6 @@ $ bash tools/build.sh -d /path/to/local/project/
201201
```
202202
> `project` 为新仓库名称。
203203
204-
如果你想使用 Project 网站,修改配置文件的 `baseurl` 为项目名称,以斜杠开头,如:`/project`。或者,在上述命令行后面加参数`-b /project``project` 替换为新仓库名称。
205-
206204
生成的静态文件将会在 `/path/to/local/project`. 把新仓库的修改提交并推送到远端 `master` 分支.
207205

208206
**3**. 回到 GithHub 网页,为该仓库开启 Pages 服务。

0 commit comments

Comments
 (0)