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
A minimal, portfolio, sidebar, bootstrap Jekyll theme with responsive web design and focuses on text exhibition. It will help you easily record and share your knowledge.
9
+
A minimal, sidebar, responsive web design Jekyll theme, focusing on text presentation. Aim to help you easily record and share your knowledge.
@@ -118,7 +117,7 @@ As mentioned above, some files or directories should be removed from your repo:
118
117
119
118
### Customization
120
119
121
-
Basically, go to `_config.yml` and customize the variables as needed, some of them are typical options:
120
+
Basically, go to `_config.yml` and configure the variables as needed. Some of them are typical options:
122
121
123
122
*`url`
124
123
@@ -157,7 +156,7 @@ Few days later, you may find that the file modification(e.g. edits to a post) do
157
156
158
157
### Deploying to GitHub Pages
159
158
160
-
Before the deployment begins, ensure the `url` in file `_config.yml`has been set to `https://<username>.github.io`(or the custom domain, if you have. e.g. `https://yourdomain.com`). What's more, if you prefer to the [Project site](https://help.github.com/en/github/working-with-github-pages/about-github-pages#types-of-github-pages-sites), change `baseurl` of file `_config.yml` to your project name, starting with a slash. e.g.`/project`.
159
+
Before the deployment begins, checkout the file `_config.yml`and make sure that the `url` has been configured. What's more, if you prefer the [Project site on GitHub](https://help.github.com/en/github/working-with-github-pages/about-github-pages#types-of-github-pages-sites) and also use the default domain `<username>.github.io`, remember to change the `baseurl` to your project name that starting with a slash. For example,`/project`.
161
160
162
161
#### Option 1: Built by GitHub Pages
163
162
@@ -170,7 +169,7 @@ By deploying the site in this way, you're allowed to push the source code direct
170
169
|Site Type | Repo's Name|
171
170
|:---|:---|
172
171
|User or Organization |`<username>.github.io`|
173
-
|Project|any one except `<username>.github.io`, let's say `project`|
172
+
|Project|Any one except `<username>.github.io`, let's say `project`|
174
173
175
174
**2**. Commit the changes of the repo first, then run the initialization script:
176
175
@@ -211,7 +210,7 @@ For security reasons, GitHub Pages runs on `safe` mode, which means the third-pa
211
210
|Site Type | Repo's Name|
212
211
|:---|:---|
213
212
|User or Organization |`<username>.github.io`|
214
-
|Project|any one except `<username>.github.io`, let's say `project`|
213
+
|Project|Any one except `<username>.github.io`, let's say `project`|
215
214
216
215
and clone it.
217
216
@@ -232,15 +231,18 @@ The generated static files will be placed in the root of `/path/to/local/project
232
231
|User or Organization |`https://<username>.github.io/`|
233
232
|Project|`https://<username>.github.io/project/`|
234
233
235
-
and enjoy!
234
+
#### Finishing work
235
+
236
+
No matter which way you choose to deploy the website on GitHub, please enforce the `HTTPS` for it. See official docs: [Configuring a publishing source for your GitHub Pages site](https://help.github.com/en/github/working-with-github-pages/securing-your-github-pages-site-with-https).
237
+
236
238
237
239
### Documentation
238
240
239
241
For more details and the better reading experience, please check out the [tutorial in demo site](https://chirpy.cotes.info/categories/tutorial/). In the meanwhile, a copy of the tutorial is also available on the [Wiki](https://github.com/cotes2020/jekyll-theme-chirpy/wiki).
240
242
241
243
## Contributing
242
244
243
-
The old saying: "Two heads are better than one. Five heads are better than two." So, welcome to report bugs, improve code quality or submit a new feature. For more information, see [contributing guidelines](.github/CONTRIBUTING.md).
245
+
The old saying, "Two heads are better than one." Consequently, welcome to report bugs, improve code quality or submit a new feature. For more information, see [contributing guidelines](.github/CONTRIBUTING.md).
Copy file name to clipboardExpand all lines: _posts/2019-08-09-getting-started.md
+7-5Lines changed: 7 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -73,7 +73,7 @@ As mentioned above, some files or directories should be removed from your repo:
73
73
74
74
## Configuration
75
75
76
-
Basically, go to `_config.yml` and customize the variables as needed, some of them are typical options:
76
+
Basically, go to `_config.yml` and configure the variables as needed. Some of them are typical options:
77
77
78
78
*`url`
79
79
@@ -112,7 +112,7 @@ Few days later, you may find that the file changes does not refresh in real time
112
112
113
113
## Deploying to GitHub Pages
114
114
115
-
Before the deployment begins, ensure the `url` in file `_config.yml`has been set to `https://<username>.github.io`(or the custom domain, if you have. e.g. `https://yourdomain.com`). What's more, if you prefer to the [Project site](https://help.github.com/en/github/working-with-github-pages/about-github-pages#types-of-github-pages-sites), change `baseurl` of file `_config.yml` to your project name, starting with a slash. e.g.`/project`.
115
+
Before the deployment begins, checkout the file `_config.yml`and make sure that the `url` has been configured. What's more, if you prefer the [Project site on GitHub](https://help.github.com/en/github/working-with-github-pages/about-github-pages#types-of-github-pages-sites) and also use the default domain `<username>.github.io`, remember to change the `baseurl` to your project name that starting with a slash. For example,`/project`.
116
116
117
117
118
118
### Option 1: Built by GitHub Pages
@@ -126,7 +126,7 @@ By deploying the site in this way, you're allowed to push the source code direct
126
126
|Site Type | Repo's Name|
127
127
|:---|:---|
128
128
|User or Organization |`<username>.github.io`|
129
-
|Project|any one except `<username>.github.io`, let's say `project`|
129
+
|Project|Any one except `<username>.github.io`, let's say `project`|
130
130
131
131
**2**. Commit the changes of the repo first, then run the initialization script:
132
132
@@ -168,7 +168,7 @@ For security reasons, GitHub Pages runs on `safe` mode, which means the third-pa
168
168
|Site Type | Repo's Name|
169
169
|:---|:---|
170
170
|User or Organization |`<username>.github.io`|
171
-
|Project|any one except `<username>.github.io`, let's say `project`|
171
+
|Project|Any one except `<username>.github.io`, let's say `project`|
172
172
173
173
and clone it.
174
174
@@ -189,4 +189,6 @@ The generated static files will be placed in the root of `/path/to/local/project
189
189
|User or Organization |`https://<username>.github.io/`|
190
190
|Project|`https://<username>.github.io/project/`|
191
191
192
-
and enjoy!
192
+
### Finishing work
193
+
194
+
No matter which way you choose to deploy the website on GitHub, please enforce the `HTTPS` for it. See official docs: [Configuring a publishing source for your GitHub Pages site](https://help.github.com/en/github/working-with-github-pages/securing-your-github-pages-site-with-https).
0 commit comments