Skip to content

Commit 6245dec

Browse files
committed
docs: improve readme
1 parent f20ed1c commit 6245dec

1 file changed

Lines changed: 26 additions & 27 deletions

File tree

README.md

Lines changed: 26 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -20,53 +20,52 @@
2020

2121
## Features
2222

23-
- Dark Theme
24-
- Localized UI language
25-
- Pinned Posts on Home Page
26-
- Hierarchical Categories
27-
- Trending Tags
28-
- Table of Contents
29-
- Last Modified Date
30-
- Syntax Highlighting
31-
- Mathematical Expressions
32-
- Mermaid Diagrams & Flowcharts
33-
- Dark Mode Images
34-
- Embed Media
35-
- Comment Systems
36-
- Built-in Search
37-
- Atom Feeds
38-
- PWA
39-
- Web Analytics
40-
- SEO & Performance Optimization
23+
- **Design & UX** - Responsive layout, Dark/Light modes, Localized UI language,
24+
and Dark mode images.
25+
- **Content Management** - Pinned posts, Hierarchical categories, Trending tags,
26+
Auto-generated Table of Contents, and Last modified dates.
27+
- **Rich Text Support** - Syntax highlighting, Mathematical expressions, Mermaid
28+
diagrams & flowcharts, and Embedded media.
29+
- **Interactivity & Outreach** - Built-in search, Multiple comment systems, and
30+
Atom feeds.
31+
- **System & Optimization** - PWA support, integrated Web analytics, and
32+
advanced SEO performance.
4133

4234
## Documentation
4335

44-
To learn how to use, develop, and upgrade the project, please refer to the [Wiki][wiki].
36+
To learn how to use, develop, and upgrade the project, please refer to the
37+
[Wiki][wiki].
4538

4639
## Contributing
4740

48-
Contributions (_pull requests_, _issues_, and _discussions_) are what make the open-source community such an amazing place
49-
to learn, inspire, and create. Any contributions you make are greatly appreciated.
50-
For details, see the "[Contributing Guidelines][contribute-guide]".
41+
Contributions (_pull requests_, _issues_, and _discussions_) are what make the
42+
open-source community such an amazing place to learn, inspire, and create. Any
43+
contributions you make are greatly appreciated.
44+
For details, please refer to our [Contributing Guidelines][contribute-guide].
5145

5246
## Credits
5347

5448
### Contributors
5549

56-
Thanks to [all the contributors][contributors] involved in the development of the project!
50+
Thanks to [all the contributors][contributors] involved in the development of
51+
the project!
5752

58-
[![all-contributors](https://contrib.rocks/image?repo=cotes2020/jekyll-theme-chirpy&columns=16)][contributors]
53+
[![all-contributors](https://contrib.rocks/image?repo=cotes2020/jekyll-theme-chirpy&columns=16&max=112)][contributors]
5954
<sub> — Made with [contrib.rocks](https://contrib.rocks)</sub>
6055

6156
### Third-Party Assets
6257

63-
This project is built on the [Jekyll][jekyllrb] ecosystem and some [great libraries][lib], and is developed using [VS Code][vscode] as well as tools provided by [JetBrains][jetbrains] under a non-commercial open-source software license.
58+
This project is built on the [Jekyll][jekyllrb] ecosystem and integrates several
59+
[great libraries][lib]. It is developed using [VS Code][vscode] and tools
60+
provided by [JetBrains][jetbrains] under a non-commercial open-source software
61+
license.
6462

65-
The avatar and favicon for the project's website are from [ClipartMAX][clipartmax].
63+
The avatar and favicon for the project's website are sourced from
64+
[ClipartMAX][clipartmax].
6665

6766
## License
6867

69-
This project is published under [MIT License][license].
68+
This project is published under the [MIT License][license].
7069

7170
[gem]: https://rubygems.org/gems/jekyll-theme-chirpy
7271
[ci]: https://github.com/cotes2020/jekyll-theme-chirpy/actions/workflows/ci.yml?query=event%3Apush+branch%3Amaster

0 commit comments

Comments
 (0)