diff --git a/_config.yml b/_config.yml index 8e54ea7f7d3..d862178cf1f 100644 --- a/_config.yml +++ b/_config.yml @@ -16,20 +16,20 @@ timezone: Asia/Shanghai title: Chirpy # the main title -tagline: A text-focused Jekyll theme # it will display as the sub-title +tagline: A text-focused Jekyll theme # it will display as the subtitle description: >- # used by seo meta and the atom feed A minimal, responsive and feature-rich Jekyll theme for technical writing. # Fill in the protocol & hostname for your site. -# e.g. 'https://username.github.io', note that it does not end with a '/'. +# E.g. 'https://username.github.io', note that it does not end with a '/'. url: "" github: - username: github_username # change to your github username + username: github_username # change to your GitHub username twitter: - username: twitter_username # change to your twitter username + username: twitter_username # change to your Twitter username social: # Change to your full name. @@ -38,8 +38,8 @@ social: email: example@domain.com # change to your email address links: # The first element serves as the copyright owner's link - - https://twitter.com/username # change to your twitter homepage - - https://github.com/username # change to your github homepage + - https://twitter.com/username # change to your Twitter homepage + - https://github.com/username # change to your GitHub homepage # Uncomment below to add more social links # - https://www.facebook.com/username # - https://www.linkedin.com/in/username @@ -71,7 +71,7 @@ analytics: cloudflare: id: # fill in your Cloudflare Web Analytics token -# Pageviews settings +# Page views settings pageviews: provider: # now only supports 'goatcounter' @@ -83,8 +83,8 @@ pageviews: # # Available options: # -# light - Use the light color scheme -# dark - Use the dark color scheme +# light — Use the light color scheme +# dark — Use the dark color scheme # theme_mode: # [light | dark] @@ -106,7 +106,7 @@ social_preview_image: # string, local or CORS resources toc: true comments: - # Global switch for the post comment system. Keeping it empty means disabled. + # Global switch for the post-comment system. Keeping it empty means disabled. provider: # [disqus | utterances | giscus] # The provider options are as follows: disqus: @@ -136,9 +136,9 @@ assets: env: # [development | production] pwa: - enabled: true # the option for PWA feature (installable) + enabled: true # The option for PWA feature (installable) cache: - enabled: true # the option for PWA offline cache + enabled: true # The option for PWA offline cache # Paths defined here will be excluded from the PWA cache. # Usually its value is the `baseurl` of another website that # shares the same domain name as the current website. diff --git a/_javascript/modules/components/search-display.js b/_javascript/modules/components/search-display.js index 21d634efd2b..40059ac10a7 100644 --- a/_javascript/modules/components/search-display.js +++ b/_javascript/modules/components/search-display.js @@ -1,5 +1,5 @@ /** - * This script make #search-result-wrapper switch to unloaded or shown automatically. + * This script make #search-result-wrapper switch to unload or shown automatically. */ const btnSbTrigger = document.getElementById('sidebar-trigger'); diff --git a/_posts/2019-08-08-text-and-typography.md b/_posts/2019-08-08-text-and-typography.md index 7064d5d4a62..a8db26a00ff 100644 --- a/_posts/2019-08-08-text-and-typography.md +++ b/_posts/2019-08-08-text-and-typography.md @@ -18,16 +18,16 @@ image: -# H1 - heading +# H1 — heading {: .mt-4 .mb-0 } -## H2 - heading +## H2 — heading {: data-toc-skip='' .mt-4 .mb-0 } -### H3 - heading +### H3 — heading {: data-toc-skip='' .mt-4 .mb-0 } -#### H4 - heading +#### H4 — heading {: data-toc-skip='' .mt-4 } diff --git a/_posts/2019-08-08-write-a-new-post.md b/_posts/2019-08-08-write-a-new-post.md index 3ad1438b508..69eaf34acbe 100644 --- a/_posts/2019-08-08-write-a-new-post.md +++ b/_posts/2019-08-08-write-a-new-post.md @@ -31,7 +31,7 @@ tags: [TAG] # TAG names should always be lowercase ### Timezone of Date -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`. +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`. ### Categories and Tags @@ -147,7 +147,7 @@ _Image Caption_ #### Size -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. +To prevent the page content layout from shifting when the image is loaded, we should set the width and height for each image. ```markdown ![Desktop View](/assets/img/sample/mockup.png){: width="700" height="400" } @@ -284,7 +284,7 @@ If you want to embed a video file directly, use the following syntax: {% include embed/video.html src='{URL}' %} ``` -Where `URL` is an URL to a video file e.g. `/path/to/sample/video.mp4`. +Where `URL` is a URL to a video file e.g. `/path/to/sample/video.mp4`. You can also specify additional attributes for the embedded video file. Here is a full list of attributes allowed. @@ -295,7 +295,7 @@ You can also specify additional attributes for the embedded video file. Here is - `muted=true` — audio will be initially silenced - `types` — specify the extensions of additional video formats separated by `|`. Ensure these files exist in the same directory as your primary video file. -Consider an example utilizing all of the above: +Consider an example using all of the above: ```liquid {% @@ -318,14 +318,14 @@ If you want to embed an audio file directly, use the following syntax: {% include embed/audio.html src='{URL}' %} ``` -Where `URL` is an URL to an audio file e.g. `/path/to/audio.mp3`. +Where `URL` is a URL to an audio file e.g. `/path/to/audio.mp3`. You can also specify additional attributes for the embedded audio file. Here is a full list of attributes allowed. - `title='Text'` — title for an audio that appears below the audio and looks same as for images - `types` — specify the extensions of additional audio formats separated by `|`. Ensure these files exist in the same directory as your primary audio file. -Consider an example utilizing all of the above: +Consider an example using all of the above: ```liquid {% @@ -365,7 +365,7 @@ There are several types of prompts: `tip`, `info`, `warning`, and `danger`. They ``` {: .nolineno } -### Filepath Hightlight +### Filepath Highlight ```md `/path/to/a/file.extend`{: .filepath} diff --git a/_posts/2019-08-09-getting-started.md b/_posts/2019-08-09-getting-started.md index 3e0327a7ebc..3cad3839a0d 100644 --- a/_posts/2019-08-09-getting-started.md +++ b/_posts/2019-08-09-getting-started.md @@ -60,7 +60,7 @@ $ bundle ### Configuration -Update the variables of `_config.yml`{: .filepath} as needed. Some of them are typical options: +Update the variables in `_config.yml`{: .filepath} as needed. Some typical options include: - `url` - `avatar` @@ -69,17 +69,17 @@ Update the variables of `_config.yml`{: .filepath} as needed. Some of them are t ### Social Contact Options -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 }. +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. -### Customizing Stylesheet +### Customizing the Stylesheet -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. +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. -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. +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. -### Customing Static Assets +### Customizing Static Assets -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. +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. 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). @@ -95,42 +95,42 @@ After a few seconds, the local service will be published at _