1
0
mirror of https://github.com/cotes2020/jekyll-theme-chirpy.git synced 2026-03-22 02:48:15 +00:00

docs: fix typos in tutorial

This commit is contained in:
Cotes Chung
2026-03-14 18:57:52 +08:00
parent fe968a7701
commit 8fd56560a4
3 changed files with 10 additions and 9 deletions

View File

@@ -99,7 +99,7 @@ Moon
## Footnote
Click the hook will locate the footnote[^footnote], and here is another footnote[^fn-nth-2].
Clicking the hook will locate the footnote[^footnote], and here is another footnote[^fn-nth-2].
## Inline code
@@ -113,7 +113,8 @@ Here is the `/path/to/the/file.extend`{: .filepath}.
### Common
```text
<!-- markdownlint-disable-next-line MD040 -->
```
This is a common code snippet, without syntax highlight and line number.
```

View File

@@ -7,7 +7,7 @@ tags: [writing]
render_with_liquid: false
---
This tutorial will guide you how to write a post in the _Chirpy_ template, and it's worth reading even if you've used Jekyll before, as many features require specific variables to be set.
This tutorial will guide you on how to write a post in the _Chirpy_ template, and it's worth reading even if you've used Jekyll before, as many features require specific variables to be set.
## Naming and Path
@@ -173,7 +173,7 @@ By default, the image is centered, but you can specify the position by using one
- **Normal position**
Image will be left aligned in below sample:
The image will be left aligned in the below sample:
```markdown
![Desktop View](/assets/img/sample/mockup.png){: .normal }
@@ -277,7 +277,7 @@ The following table shows how to get the two parameters we need in a given video
Spotify supports some additional parameters:
- `compact` - to display compact player instead (ex. `{% include embed/spotify.html id='3OuMIIFP5TxM8tLXMWYPGV' compact=1 %}`);
- `compact` - to display a compact player instead (ex. `{% include embed/spotify.html id='3OuMIIFP5TxM8tLXMWYPGV' compact=1 %}`);
- `dark` - to force dark theme (ex. `{% include embed/spotify.html id='3OuMIIFP5TxM8tLXMWYPGV' dark=1 %}`).
### Video Files
@@ -293,7 +293,7 @@ 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.
- `poster='/path/to/poster.png'` — poster image for a video that is shown while video is downloading
- `title='Text'` — title for a video that appears below the video and looks same as for images
- `title='Text'` — title for a video that appears below the video and looks the same as for images
- `autoplay=true` — video automatically begins to play back as soon as it can
- `loop=true` — automatically seek back to the start upon reaching the end of the video
- `muted=true` — audio will be initially silenced
@@ -326,7 +326,7 @@ 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
- `title='Text'` — title for an audio that appears below the audio and looks the 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 using all of the above:

View File

@@ -59,7 +59,7 @@ For Unix-like systems, you can set up the environment natively for optimal perfo
1. Follow the [Jekyll installation guide](https://jekyllrb.com/docs/installation/) to install Jekyll and ensure [Git](https://git-scm.com/) is installed.
2. Clone your repository to your local machine.
3. If you forked the theme, install [Node.js][nodejs] and run `bash tools/init.sh` in the root directory to initialize the repository.
4. Run command `bundle` in the root of your repository to install the dependencies.
4. Run command `bundle install` in the root of your repository to install the dependencies.
## Usage
@@ -105,7 +105,7 @@ Before deploying, check the `_config.yml`{: .filepath} file and ensure the `url`
Now you can choose _ONE_ of the following methods to deploy your Jekyll site.
### Deploy Using Github Actions
### Deploy Using GitHub Actions
Prepare the following: