From 30995bcdb06de06935e8eeab2ae0c6f3654a74b7 Mon Sep 17 00:00:00 2001 From: geekifan Date: Sun, 11 May 2025 21:07:35 +0800 Subject: [PATCH] docs: update README.md --- README.md | 15 ++++++--------- 1 file changed, 6 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 880b85b..299753e 100644 --- a/README.md +++ b/README.md @@ -12,10 +12,6 @@ -## Attention - -⚠️ This theme is still under active development. Some of its features will be available soon. **It will become stable in May, 2025.** (I've implemented 90% of its features till now). - ## Features - Native i18n Support (thanks to [Hugo][hugo]) @@ -26,7 +22,7 @@ - Trending Tags - Table of Contents - Last Modified Date -- Syntax Highlighting (🚧 Work in Progress) +- Syntax Highlighting - Mathematical Expressions - Mermaid Diagrams & Flowcharts (🚧 Work in Progress) - Dark Mode Images @@ -38,6 +34,9 @@ - Web Analytics - SEO & Performance Optimization +## Quick Start +Use this template: [geekifan/chirpy-starter](https://github.com/geekifan/chirpy-starter) + ## Documentation To learn how to use, develop, and upgrade the project, please refer to the [Wiki][wiki]. @@ -46,7 +45,6 @@ To learn how to use, develop, and upgrade the project, please refer to the [Wiki 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]". ## Credits @@ -59,6 +57,5 @@ This project is published under [MIT License][license]. [chirpy-jekyll]: https://github.com/cotes2020/jekyll-theme-chirpy [license]: https://github.com/geekifan/hugo-theme-chirpy/blob/main/LICENSE [hugo]: https://gohugo.io/ -[demo]: https://github.com/geekifan/ -[wiki]: https://github.com/geekifan/ -[contribute-guide]: https://github.com/geekifan/ \ No newline at end of file +[demo]: https://geekifan.github.io/chirpy-starter +[wiki]: https://geekifan.github.io/chirpy-starter \ No newline at end of file