Skip to content

Commit f614ea8

Browse files
committed
Update the docs.
1 parent dacda24 commit f614ea8

File tree

5 files changed

+16
-24
lines changed

5 files changed

+16
-24
lines changed

Diff for: .github/CONTRIBUTING.md

+2-8
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,9 @@ To ensure that the blog design is not confused, this project does not accept sug
77
Generally, contribute to the project by:
88

99
1. Fork this project on GitHub and clone it locally.
10-
2. Create a new branch named `feature/my-feature` (or `feature/fix-a-bug`), which branch from `develop`:
11-
12-
```console
13-
$ git checkout -b feature/<my-feature> develop
14-
```
15-
> Please note that the new branch name must include the prefix `feature/`.
16-
10+
2. Create a new branch from `master` and give it a descriptive name (e.g., `my-new-feature`, `fix-a-bug`).
1711
3. After completing the development, commit and push to remote.
18-
4. Submit a new **pull request** to the `develop` branch of upstream, i.e., `cotes2020/jekyll-theme-chirpy:develop`.
12+
4. Submit a new pull request.
1913

2014
---
2115

Diff for: README.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -91,11 +91,10 @@ What it does is:
9191

9292
1. Remove some files or directories from your repository:
9393
- `.travis.yml`
94-
- everything under `.github/`
95-
- files under `_posts/`
96-
- folder `docs/`
94+
- files under `_posts`
95+
- folder `docs`
9796

98-
2. Unless the option `--no-gh` was enabled, setup the GitHub action workflow by renaming `pages-deploy.yml.hook` of directory `.github/workflows/` to `pages-deploy.yml`.
97+
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`.
9998

10099
3. Automatically create a commit to save the changes.
101100

@@ -134,7 +133,8 @@ For security reasons, GitHub Pages build runs on `safe` mode, which restricts us
134133

135134
2. Unless you prefer to project sites, rename your repository to `<username>.github.io` on GitHub.
136135

137-
3. Choose branch `gh-pages` as your GitHub Pages source.
136+
3. Choose 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) for your GitHub Pages site.
137+
138138

139139
4. Visit your website at the address indicated by GitHub.
140140

Diff for: _posts/2019-08-08-write-a-new-post.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ tags: [writing]
88

99
## Naming and Path
1010

11-
Create a new file named `YYYY-MM-DD-TITLE.EXTENSION` and put it in the `_post/` of the root directory. The `EXTENSION` must be one of `md` and `markdown`. From `v2.4.1`, you can create sub-directories under `_posts/` to categorize posts.
11+
Create a new file named `YYYY-MM-DD-TITLE.EXTENSION` and put it in the `_post/` of the root directory. Please note that the `EXTENSION` must be one of `md` and `markdown`. From `v2.4.1`, you can create sub-directories under `_posts/` to categorize posts.
1212

1313
## Front Matter
1414

@@ -146,7 +146,7 @@ This is a common code snippet, without syntax highlight and line number.
146146
147147
## Specific Language
148148
149-
Using <code class="highlighter-rouge">```Language</code> you will get code snippets with line Numbers and syntax highlight.
149+
Using <code class="highlighter-rouge">```language</code> you will get code snippets with line Numbers and syntax highlight.
150150
151151
> **Note**: The Jekyll style `{% raw %}{%{% endraw %} highlight LANGUAGE {% raw %}%}{% endraw %}` or `{% raw %}{%{% endraw %} highlight LANGUAGE linenos {% raw %}%}{% endraw %}` are not allowed to be used in this theme !
152152

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

+4-5
Original file line numberDiff line numberDiff line change
@@ -61,11 +61,10 @@ What it does is:
6161

6262
1. Remove some files or directories from your repository:
6363
- `.travis.yml`
64-
- everything under `.github/`
65-
- files under `_posts/`
66-
- folder `docs/`
64+
- files under `_posts`
65+
- folder `docs`
6766

68-
2. Unless the option `--no-gh` was enabled, setup the GitHub action workflow by renaming `pages-deploy.yml.hook` of directory `.github/workflows/` to `pages-deploy.yml`.
67+
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`.
6968

7069
3. Automatically create a commit to save the changes.
7170

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

105104
2. Unless you prefer to project sites, rename your repository to `<username>.github.io` on GitHub.
106105

107-
3. Choose branch `gh-pages` as your GitHub Pages source.
106+
3. Choose 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) for your GitHub Pages site.
108107

109108
4. Visit your website at the address indicated by GitHub.
110109

Diff for: docs/README_zh-CN.md

+3-4
Original file line numberDiff line numberDiff line change
@@ -95,13 +95,12 @@ $ bash tools/init.sh
9595

9696
1. 从你的仓库中删除了:
9797
- `.travis.yml`
98-
- `.github` 下的文件和目录
9998
- `_posts` 下的文件
10099
- `docs` 目录
101100

102-
2. 配置了 GitHub Actions:把 `.github/workflows/` 的文件 `pages-deploy.yml.hook` 重命名为 `pages-deploy.yml`
101+
2. 如果使用了参数 `--no-gh`,则会怒删 `.github`。否则,将会配置 GitHub Actions:把 `.github/workflows/pages-deploy.yml.hook` 的后缀 `.hook` 去除,然后删除 `.github` 里的其他目录和文件
103102

104-
3. 自动提交一个 Commit 以保存文件的更改
103+
3. 自动提交一个 Commit 以保存上述文件的更改
105104

106105
### 配置文件
107106

@@ -139,7 +138,7 @@ $ bash tools/run.sh
139138

140139
2. 除非你是使用 project 站点, 否则重命名你的仓库为 `<username>.github.io`
141140

142-
3. 选择分支 `gh-pages` 作为 GitHub Pages 的源.
141+
3. 选择分支 `gh-pages` 作为 GitHub Pages 站点的[发布源](https://docs.github.com/en/github/working-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site).
143142

144143
4. 按照 GitHub 指示的地址去访问你的网站。
145144

0 commit comments

Comments
 (0)