You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/PULL_REQUEST_TEMPLATE.md
+8-9Lines changed: 8 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,7 +16,7 @@ Please select the desired item checkbox and change it to "[x]", then delete opti
16
16
-[ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
17
17
-[ ] Documentation update
18
18
19
-
## How has this been tested?
19
+
## How has this been tested
20
20
21
21
<!--
22
22
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
@@ -25,16 +25,15 @@ Please describe the tests that you ran to verify your changes. Provide instructi
25
25
-[ ] I have run `bash ./tools/build.sh && bash ./tools/test.sh` (at the root of the project) locally and passed
26
26
-[ ] I have tested this feature in the browser
27
27
28
-
**Test Configuration**
28
+
### Test Configuration
29
29
30
-
* Browerser type & version:
31
-
* Operating system:
32
-
* Bundler version:
33
-
* Ruby version:
34
-
* Jekyll version:
30
+
- Browerser type & version:
31
+
- Operating system:
32
+
- Bundler version:
33
+
- Ruby version:
34
+
- Jekyll version:
35
35
36
-
37
-
## Checklist:
36
+
### Checklist
38
37
<!-- Select checkboxes by change the "[ ]" to "[x]" -->
39
38
-[ ] My code follows the [Google style guidelines](https://google.github.io/styleguide/)
40
39
-[ ] I have performed a self-review of my own code
If you would like to run or build the project on your local machine, please follow the [Jekyll Docs](https://jekyllrb.com/docs/installation/) to complete the installation of `Ruby`, `RubyGems` and `Bundler`.
51
+
If you would like to run or build the project on your local machine, please follow the [Jekyll Docs](https://jekyllrb.com/docs/installation/) to complete the installation of `Ruby`, `RubyGems` and `Bundler`.
52
52
53
53
Before running or building for the first time, please complete the installation of the Jekyll plugins. Go to the root directory of project and run:
54
54
@@ -90,17 +90,18 @@ $ bash tools/init.sh
90
90
What it does is:
91
91
92
92
1. Remove some files or directories from your repository:
93
-
-`.travis.yml`
94
-
- files under `_posts`
95
-
- folder `docs`
93
+
* `.travis.yml`
94
+
* files under `_posts`
95
+
* folder `docs`
96
96
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`.
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`.
98
98
99
99
3. Automatically create a commit to save the changes.
100
100
101
101
### Configuration
102
102
103
103
Generally, go to `_config.yml` and configure the variables as needed. Some of them are typical options:
104
+
104
105
*`url`
105
106
*`avatar`
106
107
*`timezone`
@@ -121,7 +122,7 @@ Few days later, you may find that the file changes does not refresh in real time
121
122
122
123
### Deployment
123
124
124
-
Before the deployment begins, checkout the file `_config.yml` and make sure the `url` is configured correctly. Furthermore, if you prefer the [_project site_](https://help.github.com/en/github/working-with-github-pages/about-github-pages#types-of-github-pages-sites) and don't use a custom domain, or you want to visit your website with a base url on a web server other than **GitHub Pages**, remember to change the `baseurl` to your project name that starting with a slash. For example, `/project`.
125
+
Before the deployment begins, checkout the file `_config.yml` and make sure the `url` is configured correctly. Furthermore, if you prefer the [*project site*](https://help.github.com/en/github/working-with-github-pages/about-github-pages#types-of-github-pages-sites) and don't use a custom domain, or you want to visit your website with a base url on a web server other than **GitHub Pages**, remember to change the `baseurl` to your project name that starting with a slash. For example, `/project`.
125
126
126
127
Assuming you have already gone through the [initialization](#initialization), you can now choose any of the following methods to deploy your website.
127
128
@@ -130,12 +131,8 @@ Assuming you have already gone through the [initialization](#initialization), yo
130
131
For security reasons, GitHub Pages build runs on `safe` mode, which restricts us from using tool scripts to generate additional page files. Therefore, we can use GitHub Actions to build the site, store the built site files on a new branch, and use that branch as the source of the Pages service.
131
132
132
133
1. Push any commit to `origin/master` to trigger the GitHub Actions workflow. Once the build is complete, a new remote branch called `gh-pages` will appear, which is used to store the built site files.
133
-
134
134
2. Unless you prefer to project sites, rename your repository to `<username>.github.io` on GitHub.
135
-
136
135
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
-
138
-
139
136
4. Visit your website at the address indicated by GitHub.
Copy file name to clipboardExpand all lines: _posts/2019-08-08-write-a-new-post.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -33,7 +33,7 @@ In order to accurately record the release date of a post, you should not only se
33
33
34
34
The `categories` of each post is designed to contain up to two elements, and the number of elements in `tags` can be zero to infinity.
35
35
36
-
The list of posts belonging to the same _category_/_tag_ is recorded on a separate page. At the same time, the number of these _category_/_tag_ type pages is equal to the number of `categories` / `tags` elements for all posts, which means that the two number must be exactly the same.
36
+
The list of posts belonging to the same *category*/*tag* is recorded on a separate page. At the same time, the number of these *category*/*tag* type pages is equal to the number of `categories` / `tags` elements for all posts, which means that the two number must be exactly the same.
37
37
38
38
For instance, let's say there is a post with front matter:
39
39
@@ -42,7 +42,7 @@ categories: [Animal, Insect]
42
42
tags: bee
43
43
```
44
44
45
-
Then we should have two _category_ type pages placed in folder `categories` of root and one _tag_ type page placed in folder `tags` of root:
45
+
Then we should have two *category* type pages placed in folder `categories` of root and one *tag* type page placed in folder `tags` of root:
46
46
47
47
```sh
48
48
.
@@ -54,7 +54,7 @@ Then we should have two _category_ type pages placed in folder `categories` of r
54
54
...
55
55
```
56
56
57
-
and the content of a _category_ type page is
57
+
and the content of a *category* type page is
58
58
59
59
```yaml
60
60
---
@@ -64,7 +64,7 @@ category: CATEGORY_NAME # e.g. Insect
64
64
---
65
65
```
66
66
67
-
the content of a _tag_ type page is
67
+
the content of a *tag* type page is
68
68
69
69
```yaml
70
70
---
@@ -74,7 +74,7 @@ tag: TAG_NAME # e.g. bee
74
74
---
75
75
```
76
76
77
-
With the increasing number of posts, the number of categories and tags will increase several times! If we still manually create these *category*/_tag_ type files, it will obviously be a super time-consuming job, and it is very likely to miss some of them, i.e., when you click on the missing `category` or `tag` link from a post or somewhere, the browser will complain to you "404 Not Found". The good news is we got a lovely script tool `_scripts/sh/create_pages.sh` to finish the boring tasks. Basically we will use it via `run.sh`, `build.sh`, `deploy.sh` or `publish.sh` that placed in `tools/` instead of running it separately. Check out its use case [here]({{ "/posts/getting-started/#deployment" | relative_url }}).
77
+
With the increasing number of posts, the number of categories and tags will increase several times! If we still manually create these *category*/*tag* type files, it will obviously be a super time-consuming job, and it is very likely to miss some of them, i.e., when you click on the missing `category` or `tag` link from a post or somewhere, the browser will complain to you "404 Not Found". The good news is we got a lovely script tool `_scripts/sh/create_pages.sh` to finish the boring tasks. Basically we will use it via `run.sh`, `build.sh`, `deploy.sh` or `publish.sh` that placed in `tools/` instead of running it separately. Check out its use case [here]({{ "/posts/getting-started/#deployment" | relative_url }}).
Copy file name to clipboardExpand all lines: _posts/2019-08-09-getting-started.md
+4-11Lines changed: 4 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -42,7 +42,6 @@ What's more, in order to generate some extra files (*categories*, *tags* and *la
42
42
$ brew install coreutils
43
43
```
44
44
45
-
46
45
## Usage
47
46
48
47
Running [**Chirpy**](https://github.com/cotes2020/jekyll-theme-chirpy/) requires some extra files, which cannot be generated by Jekyll native commands, so please strictly follow the methods mentioned below to run or deploy your website.
@@ -60,12 +59,10 @@ $ bash tools/init.sh
60
59
What it does is:
61
60
62
61
1. Remove some files or directories from your repository:
63
-
-`.travis.yml`
64
-
- files under `_posts`
65
-
- folder `docs`
66
-
62
+
*`.travis.yml`
63
+
* files under `_posts`
64
+
* folder `docs`
67
65
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`.
68
-
69
66
3. Automatically create a commit to save the changes.
70
67
71
68
### Configuration
@@ -76,7 +73,6 @@ Generally, go to `_config.yml` and configure the variables as needed. Some of th
76
73
*`timezone`
77
74
*`theme_mode`
78
75
79
-
80
76
### Run Locally
81
77
82
78
You may want to preview the site contents before publishing, so just run it by:
@@ -91,7 +87,7 @@ Few days later, you may find that the file changes does not refresh in real time
91
87
92
88
### Deployment
93
89
94
-
Before the deployment begins, checkout the file `_config.yml` and make sure the `url` is configured correctly. Furthermore, if you prefer the [_project site_](https://help.github.com/en/github/working-with-github-pages/about-github-pages#types-of-github-pages-sites) and don't use a custom domain, or you want to visit your website with a base url on a web server other than **GitHub Pages**, remember to change the `baseurl` to your project name that starting with a slash. For example, `/project`.
90
+
Before the deployment begins, checkout the file `_config.yml` and make sure the `url` is configured correctly. Furthermore, if you prefer the [*project site*](https://help.github.com/en/github/working-with-github-pages/about-github-pages#types-of-github-pages-sites) and don't use a custom domain, or you want to visit your website with a base url on a web server other than **GitHub Pages**, remember to change the `baseurl` to your project name that starting with a slash. For example, `/project`.
95
91
96
92
Assuming you have already gone through the [initialization](#initialization), you can now choose any of the following methods to deploy your website.
97
93
@@ -100,11 +96,8 @@ Assuming you have already gone through the [initialization](#initialization), yo
100
96
For security reasons, GitHub Pages build runs on `safe` mode, which restricts us from using tool scripts to generate additional page files. Therefore, we can use GitHub Actions to build the site, store the built site files on a new branch, and use that branch as the source of the Pages service.
101
97
102
98
1. Push any commit to `origin/master` to trigger the GitHub Actions workflow. Once the build is complete, a new remote branch called `gh-pages` will appear, which is used to store the built site files.
103
-
104
99
2. Unless you prefer to project sites, rename your repository to `<username>.github.io` on GitHub.
105
-
106
100
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.
107
-
108
101
4. Visit your website at the address indicated by GitHub.
Copy file name to clipboardExpand all lines: _posts/2019-08-11-customize-the-favicon.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,11 +11,11 @@ In [**Chirpy**](https://github.com/cotes2020/jekyll-theme-chirpy/), the image fi
11
11
12
12
With a square image (PNG, JPG or GIF) in hand, open the site [*Favicon & App Icon Generator*](https://www.favicon-generator.org/) and upload your original image.
0 commit comments