asandikci.com/web
1
0
Fork 0
Code Issues 5 Pull requests Projects Releases Packages Wiki Activity Actions

Update Docs.

Browse source
This commit is contained in:
Cotes Chung 2020-07-09 04:52:03 +08:00
parent 46c2cfe64e
commit 313c44f238
5 changed files with 38 additions and 41 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
.github/ISSUE_TEMPLATE/question.md vendored
View file

@ -15,12 +15,8 @@ labels: question
## I don't understand what the ReadMe/Wiki says
<!--
Point out the parts that are hard for you to understand.
-->
<!-- Point out the parts that are hard for you to understand. -->
## I have other questions
<!--
Please describe your question.
-->
<!-- Please describe your question. -->

13
.github/PULL_REQUEST_TEMPLATE.md vendored
View file

@ -1,13 +1,12 @@
# Description
## Description
<!--
Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.
-->
Fixes #(issue)
e.g. Fixes #(issue)
## Type of change
**Type of change**
<!--
Please select the desired item checkbox and change it to "[x]", then delete options that are not relevant.
@ -17,7 +16,7 @@ Please select the desired item checkbox and change it to "[x]", then delete opti
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
- [ ] Documentation update
# How Has This Been Tested?
## How has this been tested?
<!--
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
@ -26,7 +25,7 @@ Please describe the tests that you ran to verify your changes. Provide instructi
- [ ] I have run `bash ./tools/build.sh && bash ./tools/test.sh` (at the root of the project) locally and passed
- [ ] I have tested this feature in the browser
## Test Configuration
**Test Configuration**
* Browerser type & version:
* Operating system:
@ -35,7 +34,7 @@ Please describe the tests that you ran to verify your changes. Provide instructi
* Jekyl version:
# Checklist:
## Checklist:
<!-- Select checkboxes by change the "[ ]" to "[x]" -->
- [ ] My code follows the [Google style guidelines](https://google.github.io/styleguide/)
- [ ] I have performed a self-review of my own code

25
README.md
View file

@ -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:

26
_posts/2019-08-09-getting-started.md
View file

@ -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:

7
docs/README_zh-CN.md
View file

@ -114,10 +114,11 @@ jekyll-theme-chirpy/
```
你需要将以下文件或目录删除:
如备注所述，部分文件或目录需要被删除:
- .travis.yml
- .github
```terminal
$ rm -rf .travis.yml .github _posts/*
```
### 配置文件