From ba397a21aa628c2dd49159e58d95bb8042a6ad8b Mon Sep 17 00:00:00 2001 From: Cotes Chung <11371340+cotes2020@users.noreply.github.com> Date: Sun, 13 Aug 2023 14:39:40 +0800 Subject: [PATCH] docs: fix the badge links on README and improve the content --- README.md | 45 +++++++++++++++++++++++---------------------- 1 file changed, 23 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index a99e041..5dd55f1 100644 --- a/README.md +++ b/README.md @@ -4,10 +4,10 @@ A minimal, responsive and feature-rich Jekyll theme for technical writing. - [![Gem Version](https://img.shields.io/gem/v/jekyll-theme-chirpy?color=brightgreen)](https://rubygems.org/gems/jekyll-theme-chirpy) - [![CI](https://github.com/cotes2020/jekyll-theme-chirpy/actions/workflows/ci.yml/badge.svg)](https://github.com/cotes2020/jekyll-theme-chirpy/actions/workflows/ci.yml) - [![Codacy Badge](https://app.codacy.com/project/badge/Grade/4e556876a3c54d5e8f2d2857c4f43894)](https://www.codacy.com/gh/cotes2020/jekyll-theme-chirpy/dashboard?utm_source=github.com&utm_medium=referral&utm_content=cotes2020/jekyll-theme-chirpy&utm_campaign=Badge_Grade) - [![GitHub license](https://img.shields.io/github/license/cotes2020/jekyll-theme-chirpy.svg)](https://github.com/cotes2020/jekyll-theme-chirpy/blob/master/LICENSE) + [![Gem Version](https://img.shields.io/gem/v/jekyll-theme-chirpy?color=brightgreen)][gem]  + [![CI](https://github.com/cotes2020/jekyll-theme-chirpy/actions/workflows/ci.yml/badge.svg?branch=master&event=push)][ci]  + [![Codacy Badge](https://app.codacy.com/project/badge/Grade/4e556876a3c54d5e8f2d2857c4f43894)][codacy]  + [![GitHub license](https://img.shields.io/github/license/cotes2020/jekyll-theme-chirpy.svg)][license]  [![996.icu](https://img.shields.io/badge/link-996.icu-%23FF4D5B.svg)](https://996.icu) [**Live Demo →**][demo] @@ -26,18 +26,18 @@ - Dark / Light Theme Mode - Localized UI language - - Pinned Posts + - Pinned Posts on Home Page - Hierarchical Categories - Trending Tags - Table of Contents - - Last Modified Date of Posts + - Last Modified Date - Syntax Highlighting - Mathematical Expressions - - Mermaid Diagram & Flowchart + - Mermaid Diagrams & Flowcharts - Dark / Light Mode Images - Embed Videos - Disqus / Utterances / Giscus Comments - - Search + - Built-in Search - Atom Feeds - Google Analytics - SEO & Performance Optimization @@ -47,13 +47,12 @@ ## Documentation -To explore usage, development, and upgrade guide of the project, please refer to -the [Wiki][wiki]. +To explore usage, development, and upgrade guide of the project, please refer to the [**Wiki**][wiki]. ## Contributing -Welcome to report bugs, help improve the code or submit new features. -For more information, please see the ["Contributing Guidelines"][contribute-guide]. +Reporting bugs and helping to improve source code or documentation is always welcome. +For more information, see the "[Contributing Guidelines][contribute-guide]". ## Credits @@ -61,25 +60,27 @@ This theme is mainly built with [Jekyll][jekyllrb] ecosystem, [Bootstrap][bootstrap], [Font Awesome][icons] and some other [wonderful tools][lib]. The avatar and favicon design come from [Clipart Max][image]. -Thanks to all the [contributors][contributors]. Also, folks who submitted issues -or unmerged PRs should not be forgotten. Because they reported bugs, shared ideas, -or inspired me to write more readable documentation. +Many thanks to the [contributors][contributors] who participated in the development +and to the folks who reported bugs or shared ideas. -Last but not least, thanks to [JetBrains][jetbrains] for providing the -_Open Source Development_ license. +Last but not least, thanks to [JetBrains][jetbrains] for providing the _Open Source License_. ## Sponsoring If you'd like to sponsor this project, the following options are available. -[![Ko-fi](https://img.shields.io/badge/-Buy%20Me%20a%20Coffee-ff5f5f?logo=ko-fi&logoColor=white)](https://ko-fi.com/coteschung) -[![Wechat Pay](https://img.shields.io/badge/-Tip%20Me%20on%20WeChat-brightgreen?logo=wechat&logoColor=white)][donation] -[![Alipay](https://img.shields.io/badge/-Tip%20Me%20on%20Alipay-blue?logo=alipay&logoColor=white)][donation] +[![Ko-fi](https://img.shields.io/badge/Support_Me_on_Ko--fi-ff5e5b?logo=ko-fi&logoColor=white)][ko-fi]  +[![Wechat Pay](https://img.shields.io/badge/Tip_Me_on_WeChat-brightgreen?logo=wechat&logoColor=white)][donation]  +[![Alipay](https://img.shields.io/badge/Tip_Me_on_Alipay-blue?logo=alipay&logoColor=white)][donation] ## License -This work is published under [MIT][mit] License. +This work is published under [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 +[codacy]: https://app.codacy.com/gh/cotes2020/jekyll-theme-chirpy/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade +[license]: https://github.com/cotes2020/jekyll-theme-chirpy/blob/master/LICENSE [jekyllrb]: https://jekyllrb.com/ [bootstrap]: https://getbootstrap.com/ [icons]: https://fontawesome.com/ @@ -90,5 +91,5 @@ This work is published under [MIT][mit] License. [contributors]: https://github.com/cotes2020/jekyll-theme-chirpy/graphs/contributors [lib]: https://github.com/cotes2020/chirpy-static-assets [jetbrains]: https://www.jetbrains.com/?from=jekyll-theme-chirpy +[ko-fi]: https://ko-fi.com/coteschung/ [donation]: https://sponsor.cotes.page/ -[mit]: https://github.com/cotes2020/jekyll-theme-chirpy/blob/master/LICENSE