From 313c44f23894a92b0f0add1b5f9001b0e4d655b4 Mon Sep 17 00:00:00 2001 From: Cotes Chung <11371340+cotes2020@users.noreply.github.com> Date: Thu, 9 Jul 2020 04:52:03 +0800 Subject: [PATCH] Update Docs. --- .github/ISSUE_TEMPLATE/question.md | 8 ++------ .github/PULL_REQUEST_TEMPLATE.md | 13 ++++++------- README.md | 25 +++++++++++++------------ _posts/2019-08-09-getting-started.md | 26 +++++++++++++------------- docs/README_zh-CN.md | 7 ++++--- 5 files changed, 38 insertions(+), 41 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md index 17eaa8c..a45ac0b 100644 --- a/.github/ISSUE_TEMPLATE/question.md +++ b/.github/ISSUE_TEMPLATE/question.md @@ -15,12 +15,8 @@ labels: question ## I don't understand what the ReadMe/Wiki says - + ## I have other questions - \ No newline at end of file + \ No newline at end of file diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 9a0b847..18e87d2 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,13 +1,12 @@ -# Description +## Description -Fixes #(issue) +e.g. Fixes #(issue) - -## Type of change +**Type of change** - [ ] My code follows the [Google style guidelines](https://google.github.io/styleguide/) - [ ] I have performed a self-review of my own code diff --git a/README.md b/README.md index 3c1a32e..aef6ef0 100644 --- a/README.md +++ b/README.md @@ -47,15 +47,15 @@ To improve the writing experience, we need to use some script tools. If your mac * Debian -```console -$ sudo apt-get install coreutils -``` + ```console + $ sudo apt-get install coreutils + ``` * macOS -```console -$ brew install coreutils -``` + ```console + $ brew install coreutils + ``` ### Jekyll Plugins @@ -66,7 +66,7 @@ $ brew install coreutils $ git clone git@github.com:USER/jekyll-theme-chirpy.git -b master ``` -and replace the `USER` above to your GitHub username. +And replace the `USER` above to your GitHub username. 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: @@ -82,7 +82,7 @@ $ bundle install ### Directory Structure -The main files and related brief introductions are listed below. +The main files and related brief introductions are listed below: ```sh jekyll-theme-chirpy/ @@ -113,8 +113,9 @@ jekyll-theme-chirpy/ As mentioned above, some files or directories should be removed from your repo: -- .travis.yml -- .github +```terminal +$ rm -rf .travis.yml .github _posts/* +``` ### Configuration @@ -164,7 +165,7 @@ Before the deployment begins, checkout the file `_config.yml` and make sure that By deploying the site in this way, you're allowed to push the source code directly to the remote. -> **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). +> **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). **1**. Rename the repository to: @@ -202,7 +203,7 @@ it will automatically generates the *Latest Modified Date* and *Categories / Tag #### Option 2: Build Locally -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**. +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**. **1**. Browse to GitHub website, create a brand new repo named: diff --git a/_posts/2019-08-09-getting-started.md b/_posts/2019-08-09-getting-started.md index 7c4c4b4..fbd4682 100644 --- a/_posts/2019-08-09-getting-started.md +++ b/_posts/2019-08-09-getting-started.md @@ -15,15 +15,15 @@ To improve the writing experience, we need to use some script tools. If your mac * Debian -```console -$ sudo apt-get install coreutils -``` + ```console + $ sudo apt-get install coreutils + ``` * macOS -```console -$ brew install coreutils -``` + ```console + $ brew install coreutils + ``` ## Jekyll Plugins @@ -34,7 +34,7 @@ $ brew install coreutils $ git clone git@github.com:USER/jekyll-theme-chirpy.git -b master ``` -and replace the `USER` above to your GitHub username. +And replace the `USER` above to your GitHub username. 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: @@ -47,7 +47,7 @@ $ bundle install ## Directory Structure -The main files and related brief introductions are listed below. +The main files and related brief introductions are listed below: ```sh jekyll-theme-chirpy/ @@ -77,9 +77,9 @@ jekyll-theme-chirpy/ As mentioned above, some files or directories should be removed from your repo: -- .travis.yml -- .github - +```terminal +$ rm -rf .travis.yml .github _posts/* +``` ## Configuration @@ -129,7 +129,7 @@ Before the deployment begins, checkout the file `_config.yml` and make sure that By deploying the site in this way, you're allowed to push the source code directly to the remote. -> **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). +> **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). **1**. Rename the repository to: @@ -167,7 +167,7 @@ it will automatically generates the *Latest Modified Date* and *Categories / Tag ### Option 2: Build Locally -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**. +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**. **1**. Browse to GitHub website, create a brand new repo named: diff --git a/docs/README_zh-CN.md b/docs/README_zh-CN.md index 1c62708..d0b6ef9 100644 --- a/docs/README_zh-CN.md +++ b/docs/README_zh-CN.md @@ -114,10 +114,11 @@ jekyll-theme-chirpy/ ``` -你需要将以下文件或目录删除: +如备注所述，部分文件或目录需要被删除: -- .travis.yml -- .github +```terminal +$ rm -rf .travis.yml .github _posts/* +``` ### 配置文件