Skip to content

Commit 25c4166

Browse files
committed
style(markdown): resolve markdownlint warnings
1 parent 25b2ffa commit 25c4166

4 files changed

+18
-11
lines changed

Diff for: README.md

+2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
1+
<!-- markdownlint-disable-next-line -->
12
<div align="center">
23

4+
<!-- markdownlint-disable-next-line -->
35
# Chirpy Jekyll Theme
46

57
A minimal, responsive, and feature-rich Jekyll theme for technical writing.

Diff for: _posts/2019-08-08-text-and-typography.md

+15-9
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@ This post is to show Markdown syntax rendering on [**Chirpy**](https://github.co
1717

1818
## Headings
1919

20+
<!-- markdownlint-capture -->
21+
<!-- markdownlint-disable -->
2022
# H1 - heading
2123
{: .mt-4 .mb-0 }
2224

@@ -28,6 +30,7 @@ This post is to show Markdown syntax rendering on [**Chirpy**](https://github.co
2830

2931
#### H4 - heading
3032
{: data-toc-skip='' .mt-4 }
33+
<!-- markdownlint-restore -->
3134

3235
## Paragraph
3336

@@ -44,15 +47,15 @@ Quisque egestas convallis ipsum, ut sollicitudin risus tincidunt a. Maecenas int
4447
### Unordered list
4548

4649
- Chapter
47-
+ Section
48-
* Paragraph
50+
- Section
51+
- Paragraph
4952

5053
### ToDo list
5154

5255
- [ ] Job
53-
+ [x] Step 1
54-
+ [x] Step 2
55-
+ [ ] Step 3
56+
- [x] Step 1
57+
- [x] Step 2
58+
- [ ] Step 3
5659

5760
### Description list
5861

@@ -68,6 +71,8 @@ Moon
6871
6972
## Prompts
7073

74+
<!-- markdownlint-capture -->
75+
<!-- markdownlint-disable -->
7176
> An example showing the `tip` type prompt.
7277
{: .prompt-tip }
7378

@@ -79,14 +84,15 @@ Moon
7984

8085
> An example showing the `danger` type prompt.
8186
{: .prompt-danger }
87+
<!-- markdownlint-restore -->
8288

8389
## Tables
8490

8591
| Company | Contact | Country |
86-
|:-----------------------------|:-----------------|--------:|
92+
| :--------------------------- | :--------------- | ------: |
8793
| Alfreds Futterkiste | Maria Anders | Germany |
88-
| Island Trading | Helen Bennett | UK |
89-
| Magazzini Alimentari Riuniti | Giovanni Rovelli | Italy |
94+
| Island Trading | Helen Bennett | UK |
95+
| Magazzini Alimentari Riuniti | Giovanni Rovelli | Italy |
9096

9197
## Links
9298

@@ -108,7 +114,7 @@ Here is the `/path/to/the/file.extend`{: .filepath}.
108114

109115
### Common
110116

111-
```
117+
```text
112118
This is a common code snippet, without syntax highlight and line number.
113119
```
114120

Diff for: _posts/2019-08-08-write-a-new-post.md

-2
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,6 @@ Adding author information in `_data/authors.yml` (If your website doesn't have t
5858
```
5959
{: file="_data/authors.yml" }
6060
61-
6261
And then use `author` to specify a single entry or `authors` to specify multiple entries:
6362

6463
```yaml
@@ -320,7 +319,6 @@ image:
320319

321320
> You can observe LQIP in the preview image of post [_Text and Typography_](/posts/text-and-typography/).
322321

323-
324322
For normal images:
325323

326324
```markdown

Diff for: _posts/2019-08-11-customize-the-favicon.md

+1
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ The following table will help you understand the changes to the favicon files:
3030
| `*.PNG` |||
3131
| `*.ICO` |||
3232

33+
<!-- markdownlint-disable-next-line -->
3334
> ✓ means keep, ✗ means delete.
3435
{: .prompt-info }
3536

0 commit comments

Comments
 (0)