From 6245dec754507cfc35fe3db6b90e7bf4dded5e94 Mon Sep 17 00:00:00 2001 From: Cotes Chung <11371340+cotes2020@users.noreply.github.com> Date: Sat, 4 Apr 2026 01:36:04 +0800 Subject: [PATCH] docs: improve readme --- README.md | 53 ++++++++++++++++++++++++++--------------------------- 1 file changed, 26 insertions(+), 27 deletions(-) diff --git a/README.md b/README.md index 7e57b2a52..f17f52253 100644 --- a/README.md +++ b/README.md @@ -20,53 +20,52 @@ ## Features -- Dark Theme -- Localized UI language -- Pinned Posts on Home Page -- Hierarchical Categories -- Trending Tags -- Table of Contents -- Last Modified Date -- Syntax Highlighting -- Mathematical Expressions -- Mermaid Diagrams & Flowcharts -- Dark Mode Images -- Embed Media -- Comment Systems -- Built-in Search -- Atom Feeds -- PWA -- Web Analytics -- SEO & Performance Optimization +- **Design & UX** - Responsive layout, Dark/Light modes, Localized UI language, + and Dark mode images. +- **Content Management** - Pinned posts, Hierarchical categories, Trending tags, + Auto-generated Table of Contents, and Last modified dates. +- **Rich Text Support** - Syntax highlighting, Mathematical expressions, Mermaid + diagrams & flowcharts, and Embedded media. +- **Interactivity & Outreach** - Built-in search, Multiple comment systems, and + Atom feeds. +- **System & Optimization** - PWA support, integrated Web analytics, and + advanced SEO performance. ## Documentation -To learn how to use, develop, and upgrade the project, please refer to the [Wiki][wiki]. +To learn how to use, develop, and upgrade the project, please refer to the +[Wiki][wiki]. ## Contributing -Contributions (_pull requests_, _issues_, and _discussions_) are what make the open-source community such an amazing place -to learn, inspire, and create. Any contributions you make are greatly appreciated. -For details, see the "[Contributing Guidelines][contribute-guide]". +Contributions (_pull requests_, _issues_, and _discussions_) are what make the +open-source community such an amazing place to learn, inspire, and create. Any +contributions you make are greatly appreciated. +For details, please refer to our [Contributing Guidelines][contribute-guide]. ## Credits ### Contributors -Thanks to [all the contributors][contributors] involved in the development of the project! +Thanks to [all the contributors][contributors] involved in the development of +the project! -[![all-contributors](https://contrib.rocks/image?repo=cotes2020/jekyll-theme-chirpy&columns=16)][contributors] +[![all-contributors](https://contrib.rocks/image?repo=cotes2020/jekyll-theme-chirpy&columns=16&max=112)][contributors] — Made with [contrib.rocks](https://contrib.rocks) ### Third-Party Assets -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. +This project is built on the [Jekyll][jekyllrb] ecosystem and integrates several +[great libraries][lib]. It is developed using [VS Code][vscode] and tools +provided by [JetBrains][jetbrains] under a non-commercial open-source software +license. -The avatar and favicon for the project's website are from [ClipartMAX][clipartmax]. +The avatar and favicon for the project's website are sourced from +[ClipartMAX][clipartmax]. ## License -This project is published under [MIT License][license]. +This project is published under the [MIT License][license]. [gem]: https://rubygems.org/gems/jekyll-theme-chirpy [ci]: https://github.com/cotes2020/jekyll-theme-chirpy/actions/workflows/ci.yml?query=event%3Apush+branch%3Amaster