style(markdown): resolve markdownlint warnings

This commit is contained in:
Cotes Chung 2024-03-02 01:28:45 +08:00
parent 25b2ffa9ba
commit 25c4166722
No known key found for this signature in database
GPG key ID: 0D9E54843167A808
4 changed files with 18 additions and 11 deletions

View file

@ -1,5 +1,7 @@
<!-- markdownlint-disable-next-line -->
<div align="center">
<!-- markdownlint-disable-next-line -->
# Chirpy Jekyll Theme
A minimal, responsive, and feature-rich Jekyll theme for technical writing.

View file

@ -17,6 +17,8 @@ This post is to show Markdown syntax rendering on [**Chirpy**](https://github.co
## Headings
<!-- markdownlint-capture -->
<!-- markdownlint-disable -->
# H1 - heading
{: .mt-4 .mb-0 }
@ -28,6 +30,7 @@ This post is to show Markdown syntax rendering on [**Chirpy**](https://github.co
#### H4 - heading
{: data-toc-skip='' .mt-4 }
<!-- markdownlint-restore -->
## Paragraph
@ -44,15 +47,15 @@ Quisque egestas convallis ipsum, ut sollicitudin risus tincidunt a. Maecenas int
### Unordered list
- Chapter
+ Section
* Paragraph
- Section
- Paragraph
### ToDo list
- [ ] Job
+ [x] Step 1
+ [x] Step 2
+ [ ] Step 3
- [x] Step 1
- [x] Step 2
- [ ] Step 3
### Description list
@ -68,6 +71,8 @@ Moon
## Prompts
<!-- markdownlint-capture -->
<!-- markdownlint-disable -->
> An example showing the `tip` type prompt.
{: .prompt-tip }
@ -79,14 +84,15 @@ Moon
> An example showing the `danger` type prompt.
{: .prompt-danger }
<!-- markdownlint-restore -->
## Tables
| Company | Contact | Country |
|:-----------------------------|:-----------------|--------:|
| :--------------------------- | :--------------- | ------: |
| Alfreds Futterkiste | Maria Anders | Germany |
| Island Trading | Helen Bennett | UK |
| Magazzini Alimentari Riuniti | Giovanni Rovelli | Italy |
| Island Trading | Helen Bennett | UK |
| Magazzini Alimentari Riuniti | Giovanni Rovelli | Italy |
## Links
@ -108,7 +114,7 @@ Here is the `/path/to/the/file.extend`{: .filepath}.
### Common
```
```text
This is a common code snippet, without syntax highlight and line number.
```

View file

@ -58,7 +58,6 @@ Adding author information in `_data/authors.yml` (If your website doesn't have t
```
{: file="_data/authors.yml" }
And then use `author` to specify a single entry or `authors` to specify multiple entries:
```yaml
@ -320,7 +319,6 @@ image:
> You can observe LQIP in the preview image of post [_Text and Typography_](/posts/text-and-typography/).
For normal images:
```markdown

View file

@ -30,6 +30,7 @@ The following table will help you understand the changes to the favicon files:
| `*.PNG` | ✓ | ✗ |
| `*.ICO` | ✓ | ✗ |
<!-- markdownlint-disable-next-line -->
> ✓ means keep, ✗ means delete.
{: .prompt-info }