chore: fix typos in project files and docs
This commit is contained in:
parent
c876731901
commit
fbba0a4204
8 changed files with 47 additions and 47 deletions
22
_config.yml
22
_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
|
||||
|
@ -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.
|
||||
|
|
|
@ -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');
|
||||
|
|
|
@ -18,16 +18,16 @@ image:
|
|||
|
||||
<!-- markdownlint-capture -->
|
||||
<!-- markdownlint-disable -->
|
||||
# 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 }
|
||||
<!-- markdownlint-restore -->
|
||||
|
||||
|
|
|
@ -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}
|
||||
|
|
|
@ -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 _<http://127.0.0.1:4
|
|||
|
||||
## Deployment
|
||||
|
||||
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`.
|
||||
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`.
|
||||
|
||||
Now you can choose _ONE_ of the following methods to deploy your Jekyll site.
|
||||
|
||||
### Deploy by Using GitHub Actions
|
||||
### Deploy Using GitHub Actions
|
||||
|
||||
There are a few things to get ready for.
|
||||
Prepare the following:
|
||||
|
||||
- If you're on the GitHub Free plan, keep your site repository public.
|
||||
- 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:
|
||||
- If you have committed `Gemfile.lock`{: .filepath} to the repository, and your local machine is not running Linux, update the platform list of the lock file:
|
||||
|
||||
```console
|
||||
$ bundle lock --add-platform x86_64-linux
|
||||
```
|
||||
|
||||
Next, configure the _Pages_ service.
|
||||
Next, configure the _Pages_ service:
|
||||
|
||||
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.
|
||||
![Build source](pages-source-light.png){: .light .border .normal w='375' h='140' }
|
||||
![Build source](pages-source-dark.png){: .dark .normal w='375' h='140' }
|
||||
|
||||
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.
|
||||
|
||||
At this point, you can go to the URL indicated by GitHub to access your site.
|
||||
You can now visit the URL provided by GitHub to access your site.
|
||||
|
||||
### Manually Build and Deploy
|
||||
### Manual Build and Deployment
|
||||
|
||||
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.
|
||||
For self-hosted servers, you will need to build the site on your local machine and then upload the site files to the server.
|
||||
|
||||
Go to the root of the source project, and build your site as follows:
|
||||
Navigate to the root of the source project, and build your site with the following command:
|
||||
|
||||
```console
|
||||
$ JEKYLL_ENV=production bundle exec jekyll b
|
||||
```
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
[nodejs]: https://nodejs.org/
|
||||
[starter]: https://github.com/cotes2020/chirpy-starter
|
||||
|
|
|
@ -123,7 +123,7 @@
|
|||
}
|
||||
|
||||
%text-highlight {
|
||||
color: var(--text-muted-hightlight-color);
|
||||
color: var(--text-muted-highlight-color);
|
||||
font-weight: 600;
|
||||
}
|
||||
|
||||
|
|
|
@ -11,7 +11,7 @@
|
|||
/* Common color */
|
||||
--text-color: rgb(175, 176, 177);
|
||||
--text-muted-color: #868686;
|
||||
--text-muted-hightlight-color: #aeaeae;
|
||||
--text-muted-highlight-color: #aeaeae;
|
||||
--heading-color: #cccccc;
|
||||
--label-color: #a7a7a7;
|
||||
--blockquote-border-color: rgb(66, 66, 66);
|
||||
|
|
|
@ -11,7 +11,7 @@
|
|||
/* Common color */
|
||||
--text-color: #34343c;
|
||||
--text-muted-color: #757575;
|
||||
--text-muted-hightlight-color: inherit;
|
||||
--text-muted-highlight-color: inherit;
|
||||
--heading-color: #2a2a2a;
|
||||
--label-color: #585858;
|
||||
--blockquote-border-color: #eeeeee;
|
||||
|
|
Loading…
Reference in a new issue