docs: improve readme content

This commit is contained in:
Cotes Chung 2023-09-27 19:21:57 +08:00
parent 75ea77d574
commit 97004ddc44
No known key found for this signature in database
GPG key ID: 0D9E54843167A808

View file

@ -19,10 +19,8 @@
## Features ## Features
<details> <details>
<summary> <summary>Click to expand/close details</summary>
<i>Click to view features</i> &nbsp;
</summary>
<p>
- Dark / Light Theme Mode - Dark / Light Theme Mode
- Localized UI language - Localized UI language
@ -36,14 +34,13 @@
- Mermaid Diagrams & Flowcharts - Mermaid Diagrams & Flowcharts
- Dark / Light Mode Images - Dark / Light Mode Images
- Embed Videos - Embed Videos
- Disqus / Utterances / Giscus Comments - Disqus / Giscus / Utterances Comments
- Built-in Search - Built-in Search
- Atom Feeds - Atom Feeds
- PWA - PWA
- Google Analytics - Google Analytics
- SEO & Performance Optimization - SEO & Performance Optimization
</p>
</details> </details>
## Documentation ## Documentation
@ -52,7 +49,9 @@ To explore usage, development, and upgrade guide of the project, please refer to
## Contributing ## Contributing
Contributions (Issues/PRs/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, see the "[Contributing Guidelines][contribute-guide]".
## Credits ## Credits
@ -67,11 +66,11 @@ Last but not least, thanks to [JetBrains][jetbrains] for providing the _Open Sou
## Sponsoring ## Sponsoring
If you'd like to sponsor this project, the following options are available. If you like this project, or have built something through it, please consider supporting me in the following ways. Any support would be greatly appreciated!
[![Ko-fi](https://img.shields.io/badge/Support_Me_on_Ko--fi-ff5e5b?logo=ko-fi&logoColor=white)][ko-fi]&nbsp; [![Ko-fi](https://img.shields.io/badge/Support_Me_on_Ko--fi-ff5e5b?logo=ko-fi&logoColor=white)][ko-fi]&nbsp;
[![Wechat Pay](https://img.shields.io/badge/Tip_Me_on_WeChat-brightgreen?logo=wechat&logoColor=white)][donation]&nbsp; [![Wechat Pay](https://img.shields.io/badge/Support_Me_on_WeChat-brightgreen?logo=wechat&logoColor=white)][donation]&nbsp;
[![Alipay](https://img.shields.io/badge/Tip_Me_on_Alipay-blue?logo=alipay&logoColor=white)][donation] [![Alipay](https://img.shields.io/badge/Support_Me_on_Alipay-blue?logo=alipay&logoColor=white)][donation]
## License ## License