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: _posts/2019-08-08-write-a-new-post.md
+7-7Lines changed: 7 additions & 7 deletions
Original file line number
Diff line number
Diff line change
@@ -31,7 +31,7 @@ tags: [TAG] # TAG names should always be lowercase
31
31
32
32
### Timezone of Date
33
33
34
-
In order to accurately record the release date of a post, you should not only set up the `timezone` of `_config.yml`{: .filepath} but also provide the post's timezone in variable `date` of its Front Matter block. Format: `+/-TTTT`, e.g. `+0800`.
34
+
To accurately record the release date of a post, you should not only set up the `timezone` of `_config.yml`{: .filepath} but also provide the post's timezone in variable `date` of its Front Matter block. Format: `+/-TTTT`, e.g. `+0800`.
35
35
36
36
### Categories and Tags
37
37
@@ -147,7 +147,7 @@ _Image Caption_
147
147
148
148
#### Size
149
149
150
-
In order to prevent the page content layout from shifting when the image is loaded, we should set the width and height for each image.
150
+
To prevent the page content layout from shifting when the image is loaded, we should set the width and height for each image.
@@ -284,7 +284,7 @@ If you want to embed a video file directly, use the following syntax:
284
284
{% include embed/video.html src='{URL}' %}
285
285
```
286
286
287
-
Where `URL` is an URL to a video file e.g. `/path/to/sample/video.mp4`.
287
+
Where `URL` is a URL to a video file e.g. `/path/to/sample/video.mp4`.
288
288
289
289
You can also specify additional attributes for the embedded video file. Here is a full list of attributes allowed.
290
290
@@ -295,7 +295,7 @@ You can also specify additional attributes for the embedded video file. Here is
295
295
- `muted=true`— audio will be initially silenced
296
296
- `types`— specify the extensions of additional video formats separated by `|`. Ensure these files exist in the same directory as your primary video file.
297
297
298
-
Consider an example utilizing all of the above:
298
+
Consider an example using all of the above:
299
299
300
300
```liquid
301
301
{%
@@ -318,14 +318,14 @@ If you want to embed an audio file directly, use the following syntax:
318
318
{% include embed/audio.html src='{URL}' %}
319
319
```
320
320
321
-
Where `URL` is an URL to an audio file e.g. `/path/to/audio.mp3`.
321
+
Where `URL` is a URL to an audio file e.g. `/path/to/audio.mp3`.
322
322
323
323
You can also specify additional attributes for the embedded audio file. Here is a full list of attributes allowed.
324
324
325
325
- `title='Text'`— title for an audio that appears below the audio and looks same as for images
326
326
- `types`— specify the extensions of additional audio formats separated by `|`. Ensure these files exist in the same directory as your primary audio file.
327
327
328
-
Consider an example utilizing all of the above:
328
+
Consider an example using all of the above:
329
329
330
330
```liquid
331
331
{%
@@ -365,7 +365,7 @@ There are several types of prompts: `tip`, `info`, `warning`, and `danger`. They
Copy file name to clipboardExpand all lines: _posts/2019-08-09-getting-started.md
+20-20Lines changed: 20 additions & 20 deletions
Original file line number
Diff line number
Diff line change
@@ -60,7 +60,7 @@ $ bundle
60
60
61
61
### Configuration
62
62
63
-
Update the variables of`_config.yml`{: .filepath} as needed. Some of them are typical options:
63
+
Update the variables in`_config.yml`{: .filepath} as needed. Some typical options include:
64
64
65
65
-`url`
66
66
-`avatar`
@@ -69,17 +69,17 @@ Update the variables of `_config.yml`{: .filepath} as needed. Some of them are t
69
69
70
70
### Social Contact Options
71
71
72
-
Social contact options are displayed at the bottom of the sidebar. You can turn on/off the specified contacts in file`_data/contact.yml`{: .filepath }.
72
+
Social contact options are displayed at the bottom of the sidebar. You can enable or disable specific contacts in the`_data/contact.yml`{: .filepath} file.
73
73
74
-
### Customizing Stylesheet
74
+
### Customizing the Stylesheet
75
75
76
-
If you need to customize the stylesheet, copy the theme's `assets/css/jekyll-theme-chirpy.scss`{: .filepath} to the same path on your Jekyll site, and then add the custom style at the end of it.
76
+
To customize the stylesheet, copy the theme's `assets/css/jekyll-theme-chirpy.scss`{: .filepath} file to the same path in your Jekyll site, and add your custom styles at the end of the file.
77
77
78
-
Starting with version `6.2.0`, if you want to overwrite the SASS variables defined in `_sass/addon/variables.scss`{: .filepath}, copy the main sass file `_sass/main.scss`{: .filepath} into the `_sass`{: .filepath} directory in your site's source, then create a new file `_sass/variables-hook.scss`{: .filepath} and assign new value.
78
+
Starting with version `6.2.0`, if you want to overwrite the SASS variables defined in `_sass/addon/variables.scss`{: .filepath}, copy the main SASS file `_sass/main.scss`{: .filepath} to the `_sass`{: .filepath} directory in your site's source, then create a new file `_sass/variables-hook.scss`{: .filepath} and assign your new values there.
79
79
80
-
### Customing Static Assets
80
+
### Customizing Static Assets
81
81
82
-
Static assets configuration was introduced in version `5.1.0`. The CDN of the static assets is defined by file `_data/origin/cors.yml`{: .filepath }, and you can replace some of them according to the network conditions in the region where your website is published.
82
+
Static assets configuration was introduced in version `5.1.0`. The CDN of the static assets is defined in `_data/origin/cors.yml`{: .filepath }. You can replace some of them based on to the network conditions in the region where your website is published.
83
83
84
84
Also, if you'd like to self-host the static assets, please refer to the [_chirpy-static-assets_](https://github.com/cotes2020/chirpy-static-assets#readme).
85
85
@@ -95,42 +95,42 @@ After a few seconds, the local service will be published at _<http://127.0.0.1:4
95
95
96
96
## Deployment
97
97
98
-
Before the deployment begins, check out the file `_config.yml`{: .filepath} 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 starts with a slash, e.g, `/project-name`.
98
+
Before deploying, check the `_config.yml`{: .filepath} file and ensure the `url` is configured correctly. If you prefer a[**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 if you want to visit your website with a base URL on a web server other than **GitHub Pages**, remember to set the `baseurl` to your project name, starting with a slash, e.g., `/project-name`.
99
99
100
100
Now you can choose _ONE_ of the following methods to deploy your Jekyll site.
101
101
102
-
### Deploy by Using GitHub Actions
102
+
### Deploy Using GitHub Actions
103
103
104
-
There are a few things to get ready for.
104
+
Prepare the following:
105
105
106
106
- If you're on the GitHub Free plan, keep your site repository public.
107
-
- If you have committed `Gemfile.lock`{: .filepath} to the repository, and your local machine is not running Linux, go to the root of your site and update the platform list of the lock-file:
107
+
- If you have committed `Gemfile.lock`{: .filepath} to the repository, and your local machine is not running Linux, update the platform list of the lockfile:
108
108
109
109
```console
110
110
$ bundle lock --add-platform x86_64-linux
111
111
```
112
112
113
-
Next, configure the _Pages_ service.
113
+
Next, configure the _Pages_ service:
114
114
115
-
1.Browse to your repository on GitHub. Select the tab _Settings_, then click _Pages_ in the left navigation bar. Then, in the **Source** section (under _Build and deployment_), select [**GitHub Actions**][pages-workflow-src] from the dropdown menu.
1.Go to your repository on GitHub. Select the _Settings_ tab, then click _Pages_ in the left navigation bar. In the **Source** section (under _Build and deployment_), select [**GitHub Actions**][pages-workflow-src] from the dropdown menu.
2. Push any commits to GitHub to trigger the _Actions_ workflow. In the _Actions_ tab of your repository, you should see the workflow _Build and Deploy_ running. Once the build is complete and successful, the site will be deployed automatically.
120
120
121
-
At this point, you can go to the URL indicated by GitHub to access your site.
121
+
You can now visit the URL provided by GitHub to access your site.
122
122
123
-
### Manually Build and Deploy
123
+
### Manual Build and Deployment
124
124
125
-
On self-hosted servers, you cannot enjoy the convenience of **GitHub Actions**. Therefore, you should build the site on your local machine and then upload the site files to the server.
125
+
For self-hosted servers, you will need to build the site on your local machine and then upload the site files to the server.
126
126
127
-
Go to the root of the source project, and build your site as follows:
127
+
Navigate to the root of the source project, and build your site with the following command:
128
128
129
129
```console
130
130
$ JEKYLL_ENV=production bundle exec jekyll b
131
131
```
132
132
133
-
Unless you specified the output path, the generated site files will be placed in folder`_site`{: .filepath} of the project's root directory. Now you should upload those files to the target server.
133
+
Unless you specified the output path, the generated site files will be placed in the`_site`{: .filepath} folder of the project's root directory. Upload these files to your target server.
0 commit comments