mmckinnon/hugo-theme-chirpy
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: update README.md

Browse Source
This commit is contained in:
geekifan
2025-05-11 21:07:35 +08:00
parent ae513d5e9e
commit 30995bcdb0
1 changed files with 6 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -12,10 +12,6 @@
</div> </div>
## 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 ## Features
- Native i18n Support (thanks to [Hugo][hugo]) - Native i18n Support (thanks to [Hugo][hugo])
@ -26,7 +22,7 @@
- Trending Tags - Trending Tags
- Table of Contents - Table of Contents
- Last Modified Date - Last Modified Date
- Syntax Highlighting (🚧 Work in Progress) - Syntax Highlighting
- Mathematical Expressions - Mathematical Expressions
- Mermaid Diagrams & Flowcharts (🚧 Work in Progress) - Mermaid Diagrams & Flowcharts (🚧 Work in Progress)
- Dark Mode Images - Dark Mode Images
@ -38,6 +34,9 @@
- Web Analytics - Web Analytics
- SEO & Performance Optimization - SEO & Performance Optimization
## Quick Start
Use this template: [geekifan/chirpy-starter](https://github.com/geekifan/chirpy-starter)
## Documentation ## 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].
@ -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 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. to learn, inspire, and create. Any contributions you make are greatly appreciated.
For details, see the "[Contributing Guidelines][contribute-guide]".
## Credits ## Credits
@ -59,6 +57,5 @@ This project is published under [MIT License][license].
[chirpy-jekyll]: https://github.com/cotes2020/jekyll-theme-chirpy [chirpy-jekyll]: https://github.com/cotes2020/jekyll-theme-chirpy
[license]: https://github.com/geekifan/hugo-theme-chirpy/blob/main/LICENSE [license]: https://github.com/geekifan/hugo-theme-chirpy/blob/main/LICENSE
[hugo]: https://gohugo.io/ [hugo]: https://gohugo.io/
[demo]: https://github.com/geekifan/ [demo]: https://geekifan.github.io/chirpy-starter
[wiki]: https://github.com/geekifan/ [wiki]: https://geekifan.github.io/chirpy-starter
[contribute-guide]: https://github.com/geekifan/