From db06610fd6d53f64379345220900a2a254a5a38b Mon Sep 17 00:00:00 2001 From: Cotes Chung <11371340+cotes2020@users.noreply.github.com> Date: Tue, 11 Aug 2020 00:36:22 +0800 Subject: [PATCH] Update the docs. --- .github/CONTRIBUTING.md | 10 ++-------- README.md | 10 +++++----- _posts/2019-08-08-write-a-new-post.md | 4 ++-- _posts/2019-08-09-getting-started.md | 9 ++++----- docs/README_zh-CN.md | 7 +++---- 5 files changed, 16 insertions(+), 24 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index c72187d..ca532e0 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -7,15 +7,9 @@ To ensure that the blog design is not confused, this project does not accept sug Generally, contribute to the project by: 1. Fork this project on GitHub and clone it locally. -2. Create a new branch named `feature/my-feature` (or `feature/fix-a-bug`), which branch from `develop`: - - ```console - $ git checkout -b feature/ develop - ``` - > Please note that the new branch name must include the prefix `feature/`. - +2. Create a new branch from `master` and give it a descriptive name (e.g., `my-new-feature`, `fix-a-bug`). 3. After completing the development, commit and push to remote. -4. Submit a new **pull request** to the `develop` branch of upstream, i.e., `cotes2020/jekyll-theme-chirpy:develop`. +4. Submit a new pull request. --- diff --git a/README.md b/README.md index 52a2f90..1210ab5 100644 --- a/README.md +++ b/README.md @@ -91,11 +91,10 @@ What it does is: 1. Remove some files or directories from your repository: - `.travis.yml` - - everything under `.github/` - - files under `_posts/` - - folder `docs/` + - files under `_posts` + - folder `docs` -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`. +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`. 3. Automatically create a commit to save the changes. @@ -134,7 +133,8 @@ For security reasons, GitHub Pages build runs on `safe` mode, which restricts us 2. Unless you prefer to project sites, rename your repository to `.github.io` on GitHub. -3. Choose branch `gh-pages` as your GitHub Pages source. +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. + 4. Visit your website at the address indicated by GitHub. diff --git a/_posts/2019-08-08-write-a-new-post.md b/_posts/2019-08-08-write-a-new-post.md index 4102687..4d16d8b 100644 --- a/_posts/2019-08-08-write-a-new-post.md +++ b/_posts/2019-08-08-write-a-new-post.md @@ -8,7 +8,7 @@ tags: [writing] ## Naming and Path -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. +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. ## Front Matter @@ -146,7 +146,7 @@ This is a common code snippet, without syntax highlight and line number. ## Specific Language -Using ```Language you will get code snippets with line Numbers and syntax highlight. +Using ```language you will get code snippets with line Numbers and syntax highlight. > **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 ! diff --git a/_posts/2019-08-09-getting-started.md b/_posts/2019-08-09-getting-started.md index 62bfb8b..8c62f36 100644 --- a/_posts/2019-08-09-getting-started.md +++ b/_posts/2019-08-09-getting-started.md @@ -61,11 +61,10 @@ What it does is: 1. Remove some files or directories from your repository: - `.travis.yml` - - everything under `.github/` - - files under `_posts/` - - folder `docs/` + - files under `_posts` + - folder `docs` -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`. +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`. 3. Automatically create a commit to save the changes. @@ -104,7 +103,7 @@ For security reasons, GitHub Pages build runs on `safe` mode, which restricts us 2. Unless you prefer to project sites, rename your repository to `.github.io` on GitHub. -3. Choose branch `gh-pages` as your GitHub Pages source. +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. 4. Visit your website at the address indicated by GitHub. diff --git a/docs/README_zh-CN.md b/docs/README_zh-CN.md index d5513ec..d84c784 100644 --- a/docs/README_zh-CN.md +++ b/docs/README_zh-CN.md @@ -95,13 +95,12 @@ $ bash tools/init.sh 1. 从你的仓库中删除了: - `.travis.yml` - - `.github` 下的文件和目录 - `_posts` 下的文件 - `docs` 目录 -2. 配置了 GitHub Actions：把 `.github/workflows/` 的文件 `pages-deploy.yml.hook` 重命名为 `pages-deploy.yml`。 +2. 如果使用了参数 `--no-gh`，则会怒删 `.github`。否则，将会配置 GitHub Actions：把 `.github/workflows/pages-deploy.yml.hook` 的后缀 `.hook` 去除，然后删除 `.github` 里的其他目录和文件。 -3. 自动提交一个 Commit 以保存文件的更改。 +3. 自动提交一个 Commit 以保存上述文件的更改。 ### 配置文件 @@ -139,7 +138,7 @@ $ bash tools/run.sh 2. 除非你是使用 project 站点, 否则重命名你的仓库为 `.github.io`。 -3. 选择分支 `gh-pages` 作为 GitHub Pages 的源. +3. 选择分支 `gh-pages` 作为 GitHub Pages 站点的[发布源](https://docs.github.com/en/github/working-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site). 4. 按照 GitHub 指示的地址去访问你的网站。