Skip to content

Commit 8fd5656

Browse files
committed
docs: fix typos in tutorial
1 parent fe968a7 commit 8fd5656

3 files changed

Lines changed: 10 additions & 9 deletions

File tree

_posts/2019-08-08-text-and-typography.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ Moon
9999

100100
## Footnote
101101

102-
Click the hook will locate the footnote[^footnote], and here is another footnote[^fn-nth-2].
102+
Clicking the hook will locate the footnote[^footnote], and here is another footnote[^fn-nth-2].
103103

104104
## Inline code
105105

@@ -113,7 +113,8 @@ Here is the `/path/to/the/file.extend`{: .filepath}.
113113

114114
### Common
115115

116-
```text
116+
<!-- markdownlint-disable-next-line MD040 -->
117+
```
117118
This is a common code snippet, without syntax highlight and line number.
118119
```
119120

_posts/2019-08-08-write-a-new-post.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ tags: [writing]
77
render_with_liquid: false
88
---
99

10-
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.
10+
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.
1111

1212
## Naming and Path
1313

@@ -173,7 +173,7 @@ By default, the image is centered, but you can specify the position by using one
173173

174174
- **Normal position**
175175

176-
Image will be left aligned in below sample:
176+
The image will be left aligned in the below sample:
177177

178178
```markdown
179179
![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
277277

278278
Spotify supports some additional parameters:
279279

280-
- `compact` - to display compact player instead (ex. `{% include embed/spotify.html id='3OuMIIFP5TxM8tLXMWYPGV' compact=1 %}`);
280+
- `compact` - to display a compact player instead (ex. `{% include embed/spotify.html id='3OuMIIFP5TxM8tLXMWYPGV' compact=1 %}`);
281281
- `dark` - to force dark theme (ex. `{% include embed/spotify.html id='3OuMIIFP5TxM8tLXMWYPGV' dark=1 %}`).
282282

283283
### Video Files
@@ -293,7 +293,7 @@ Where `URL` is a URL to a video file e.g. `/path/to/sample/video.mp4`.
293293
You can also specify additional attributes for the embedded video file. Here is a full list of attributes allowed.
294294

295295
- `poster='/path/to/poster.png'` — poster image for a video that is shown while video is downloading
296-
- `title='Text'` — title for a video that appears below the video and looks same as for images
296+
- `title='Text'` — title for a video that appears below the video and looks the same as for images
297297
- `autoplay=true` — video automatically begins to play back as soon as it can
298298
- `loop=true` — automatically seek back to the start upon reaching the end of the video
299299
- `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`.
326326

327327
You can also specify additional attributes for the embedded audio file. Here is a full list of attributes allowed.
328328

329-
- `title='Text'` — title for an audio that appears below the audio and looks same as for images
329+
- `title='Text'` — title for an audio that appears below the audio and looks the same as for images
330330
- `types` — specify the extensions of additional audio formats separated by `|`. Ensure these files exist in the same directory as your primary audio file.
331331

332332
Consider an example using all of the above:

_posts/2019-08-09-getting-started.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ For Unix-like systems, you can set up the environment natively for optimal perfo
5959
1. Follow the [Jekyll installation guide](https://jekyllrb.com/docs/installation/) to install Jekyll and ensure [Git](https://git-scm.com/) is installed.
6060
2. Clone your repository to your local machine.
6161
3. If you forked the theme, install [Node.js][nodejs] and run `bash tools/init.sh` in the root directory to initialize the repository.
62-
4. Run command `bundle` in the root of your repository to install the dependencies.
62+
4. Run command `bundle install` in the root of your repository to install the dependencies.
6363

6464
## Usage
6565

@@ -105,7 +105,7 @@ Before deploying, check the `_config.yml`{: .filepath} file and ensure the `url`
105105

106106
Now you can choose _ONE_ of the following methods to deploy your Jekyll site.
107107

108-
### Deploy Using Github Actions
108+
### Deploy Using GitHub Actions
109109

110110
Prepare the following:
111111

0 commit comments

Comments
 (0)