From 1b1fa93cf6ada4ccbe15f1d3d3301332123d3b60 Mon Sep 17 00:00:00 2001 From: Cotes Chung <11371340+cotes2020@users.noreply.github.com> Date: Sat, 6 Feb 2021 01:58:50 +0800 Subject: [PATCH] Fix typo in readme & quick-start tutorial --- README.md | 34 +++++++++++++++++----------- _posts/2019-08-09-getting-started.md | 16 ++++++------- docs/README.zh-CN.md | 12 ++++++++-- 3 files changed, 39 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index 4d074c4..da8da96 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ Language: English | [简体中文](https://github.com/cotes2020/jekyll-theme-chi [![Gem Version](https://img.shields.io/gem/v/jekyll-theme-chirpy?color=brightgreen)](https://rubygems.org/gems/jekyll-theme-chirpy) [![Build Status](https://github.com/cotes2020/jekyll-theme-chirpy/workflows/build/badge.svg?branch=master&event=push)](https://github.com/cotes2020/jekyll-theme-chirpy/actions?query=branch%3Amaster+event%3Apush) [![Codacy Badge](https://api.codacy.com/project/badge/Grade/8220b926db514f13afc3f02b7f884f4b)](https://app.codacy.com/manual/cotes2020/jekyll-theme-chirpy?utm_source=github.com&utm_medium=referral&utm_content=cotes2020/jekyll-theme-chirpy&utm_campaign=Badge_Grade_Dashboard) -[![GitHub license](https://img.shields.io/github/license/cotes2020/jekyll-theme-chirpy.svg?color=blue)](https://github.com/cotes2020/jekyll-theme-chirpy/blob/master/LICENSE) +[![GitHub license](https://img.shields.io/github/license/cotes2020/jekyll-theme-chirpy.svg)](https://github.com/cotes2020/jekyll-theme-chirpy/blob/master/LICENSE) [![996.icu](https://img.shields.io/badge/link-996.icu-%23FF4D5B.svg)](https://996.icu) A minimal, sidebar, responsive web design Jekyll theme that focuses on text presentation. Designed to help you record and share your knowledge easily. [Live Demo »](https://chirpy.cotes.info) @@ -21,7 +21,7 @@ A minimal, sidebar, responsive web design Jekyll theme that focuses on text pres - [Documentation](#documentation) - [Contributing](#contributing) - [Credits](#credits) -- [Supporting](#supporting) +- [Support](#support) - [License](#license) ## Features @@ -50,10 +50,10 @@ Follow the [Jekyll Docs](https://jekyllrb.com/docs/installation/) to complete th There are two ways to get the theme: -- **Install from RubyGems** - Easy to upgrade, isolate irrelevant project files so you can focus on writing. -- **Fork from GitHub** - Convenient for custom development, but difficult to upgrade, only suitable for web developers. +- **Install from RubyGems** - Easy to update, isolate irrelevant project files so you can focus on writing. +- **Fork on GitHub** - Convenient for custom development, but difficult to update, only suitable for web developers. -### Install From RubyGems +### Installing the Theme Gem Add this line to your Jekyll site's `Gemfile`: @@ -77,15 +77,15 @@ Finally, copy the required files from the theme's gem (for detailed files, see [ > **Hint**: To locate the installed theme’s gem, execute: > -```console -$ bundle info --path jekyll-theme-chirpy -``` +> ```console +> $ bundle info --path jekyll-theme-chirpy +> ``` Or you can [**use the starter template**][use-starter] to create a Jekyll site to save time copying files from theme's gem. We have prepared everything for you there! -### Fork From GitHub +### Fork on GitHub -[Fork **Chirpy**](https://github.com/cotes2020/jekyll-theme-chirpy/fork) from GitHub and clone your fork to local. +[Fork **Chirpy**](https://github.com/cotes2020/jekyll-theme-chirpy/fork) on GitHub and then clone your fork to local. Install gem dependencies by: @@ -209,9 +209,13 @@ Also, thank [JetBrains][jb] for providing the open source license. [![JB-logo](https://cdn.jsdelivr.net/gh/cotes2020/chirpy-images/commons/jetbrains.svg)][jb] -## Supporting +## Support -If you enjoy this theme or find it helpful, please consider becoming my sponsor, I'd really appreciate it! Click the button :heart: Sponsor at the top of the [Home Page](https://github.com/cotes2020/jekyll-theme-chirpy) and choose a link that suits you to donate; this will encourage and help me better maintain the project. +If you like this theme or find it helpful, please consider sponsoring me, because it will encourage and help me better maintain the project, I will be very grateful! + +[![Buy Me a Coffee](https://img.shields.io/badge/Support-Buy%20Me%20a%20Coffee-orange)](https://www.buymeacoffee.com/coteschung) +[![CN Donation](https://img.shields.io/badge/Support-WeChat%20Pay-brightgreen)][cn-donation] +[![CN Donation](https://img.shields.io/badge/Support-Alipay-blue)][cn-donation] ## License @@ -220,5 +224,9 @@ This work is published under [MIT](https://github.com/cotes2020/jekyll-theme-chi [starter]: https://github.com/cotes2020/chirpy-starter [use-starter]: https://github.com/cotes2020/chirpy-starter/generate [workflow]: https://github.com/cotes2020/jekyll-theme-chirpy/blob/master/.github/workflows/pages-deploy.yml.hook -[jb]: https://www.jetbrains.com/?from=jekyll-theme-chirpy + + + +[jb]: https://www.jetbrains.com/?from=jekyll-theme-chirpy +[cn-donation]: https://cotes.gitee.io/alipay-wechat-donation/ diff --git a/_posts/2019-08-09-getting-started.md b/_posts/2019-08-09-getting-started.md index d7095aa..fb40577 100644 --- a/_posts/2019-08-09-getting-started.md +++ b/_posts/2019-08-09-getting-started.md @@ -15,10 +15,10 @@ Follow the [Jekyll Docs](https://jekyllrb.com/docs/installation/) to complete th There are two ways to get the theme: -- **Install from RubyGems** - Easy to upgrade, isolate irrelevant project files so you can focus on writing. -- **Fork from GitHub** - Convenient for custom development, but difficult to upgrade, only suitable for web developers. +- **Install from RubyGems** - Easy to update, isolate irrelevant project files so you can focus on writing. +- **Fork on GitHub** - Convenient for custom development, but difficult to update, only suitable for web developers. -### Install From RubyGems +### Installing the Theme Gem Add this line to your Jekyll site's `Gemfile`: @@ -42,15 +42,15 @@ Finally, copy the required files from the theme's gem (for detailed files, see [ > **Hint**: To locate the installed theme’s gem, execute: > -```console -$ bundle info --path jekyll-theme-chirpy -``` +> ```console +> $ bundle info --path jekyll-theme-chirpy +> ``` Or you can [**use the starter template**][use-starter] to create a Jekyll site to save time copying files from theme's gem. We have prepared everything for you there! -### Fork From GitHub +### Fork on GitHub -[Fork **Chirpy**](https://github.com/cotes2020/jekyll-theme-chirpy/fork) from GitHub and clone your fork to local. +[Fork **Chirpy**](https://github.com/cotes2020/jekyll-theme-chirpy/fork) on GitHub and then clone your fork to local. Install gem dependencies by: diff --git a/docs/README.zh-CN.md b/docs/README.zh-CN.md index 529fe08..078fecc 100644 --- a/docs/README.zh-CN.md +++ b/docs/README.zh-CN.md @@ -5,7 +5,7 @@ Language: [English](https://github.com/cotes2020/jekyll-theme-chirpy#readme) | [![Gem Version](https://img.shields.io/gem/v/jekyll-theme-chirpy?color=brightgreen)](https://rubygems.org/gems/jekyll-theme-chirpy) [![Build Status](https://github.com/cotes2020/jekyll-theme-chirpy/workflows/build/badge.svg?branch=master&event=push)](https://github.com/cotes2020/jekyll-theme-chirpy/actions?query=branch%3Amaster+event%3Apush) [![Codacy Badge](https://api.codacy.com/project/badge/Grade/8220b926db514f13afc3f02b7f884f4b)](https://app.codacy.com/manual/cotes2020/jekyll-theme-chirpy?utm_source=github.com&utm_medium=referral&utm_content=cotes2020/jekyll-theme-chirpy&utm_campaign=Badge_Grade_Dashboard) -[![GitHub license](https://img.shields.io/github/license/cotes2020/jekyll-theme-chirpy.svg?color=blue)](https://github.com/cotes2020/jekyll-theme-chirpy/blob/master/LICENSE) +[![GitHub license](https://img.shields.io/github/license/cotes2020/jekyll-theme-chirpy.svg)](https://github.com/cotes2020/jekyll-theme-chirpy/blob/master/LICENSE) [![996.icu](https://img.shields.io/badge/link-996.icu-%23FF4D5B.svg)](https://996.icu) 一个不一样的 Jekyll 主题，采用响应式设计，方便记录、管理、分享您的知识和经验。[懂的进 »](https://chirpy.cotes.info) @@ -214,7 +214,11 @@ $ docker run -it --rm \ ## 赞助 -如果您喜欢这个主题或者它对您有帮助，请考虑打赏作者：在 [项目主页](https://github.com/cotes2020/jekyll-theme-chirpy) 点击按钮 :heart: Sponsor 选择适合的链接即可完成（国内一般选第二个链接，支付宝/微信赞助），您的打赏将会极大地鼓励作者，并帮助作者更好地维护项目！ +如果您喜欢这个主题或者它对您有帮助，请考虑打赏作者，您的支持将会极大地鼓励作者，并帮助作者更好地维护项目！ + +[![Buy Me a Coffee](https://img.shields.io/badge/Support-Buy%20Me%20a%20Coffee-orange)](https://www.buymeacoffee.com/coteschung) +[![CN Donation](https://img.shields.io/badge/Support-WeChat%20Pay-brightgreen)][cn-donation] +[![CN Donation](https://img.shields.io/badge/Support-Alipay-blue)][cn-donation] ## 许可证书 @@ -223,4 +227,8 @@ $ docker run -it --rm \ [starter]: https://github.com/cotes2020/chirpy-starter [use-starter]: https://github.com/cotes2020/chirpy-starter/generate [workflow]: https://github.com/cotes2020/jekyll-theme-chirpy/blob/master/.github/workflows/pages-deploy.yml.hook + + + [jb]: https://www.jetbrains.com/?from=jekyll-theme-chirpy +[cn-donation]: https://cotes.gitee.io/alipay-wechat-donation/