From c2a7480e653aa82d1747091154c3307a4676c11c Mon Sep 17 00:00:00 2001 From: Cotes Chung <11371340+cotes2020@users.noreply.github.com> Date: Sun, 26 Sep 2021 01:20:50 +0800 Subject: [PATCH] Update README --- README.md | 35 ++++++++++++++--------------------- 1 file changed, 14 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index 8524228..ad5ef90 100644 --- a/README.md +++ b/README.md @@ -1,28 +1,31 @@ # Chirpy Starter [![Gem Version](https://img.shields.io/gem/v/jekyll-theme-chirpy)](https://rubygems.org/gems/jekyll-theme-chirpy) [![GitHub license](https://img.shields.io/github/license/cotes2020/chirpy-starter.svg?color=blue)][mit] +When installing the [**Chirpy**][chirpy] theme through [RubyGems.org][gem], Jekyll can only read files in the folders `_includes`, `_layout`, `_sass` and `assets`, as well as a small part of options of the `_config.yml` file from the theme's gem. If you have ever installed this theme gem, you can use the command `bundle info --path jekyll-theme-chirpy` to locate these files. -The startup template for [**Jekyll Theme Chirpy**][chirpy]. +The Jekyll organization claims that this is to leave the ball in the user’s court, but this also results in users not being able to enjoy the out-of-the-box experience when using feature-rich themes. -When installing the **Chirpy** theme through [RubyGems][gem], Jekyll can only read files in the folders `_includes`, `_layout`, `_sass` and `assets`, as well as a small part of options of the `_config.yml` file from the theme's gem. (You can find the gem files by using the command `bundle info --path jekyll-theme-chirpy`). To fully use all the features of **Chirpy**, you need to copy the other critical files/directories from the theme's gem to your Jekyll site. - -The critical files/directories to run or build the **Chirpy** theme are as follows: +To fully use all the features of **Chirpy**, you need to copy the other critical files from the theme's gem to your Jekyll site. The following is a list of targets: ```shell . +├── _config.yml ├── _data ├── _plugins ├── _tabs -├── _config.yml -└── index.html +└── index.html ``` -So we've extracted all the **Chirpy** gem necessary content here to help you get started quickly. +In order to save your time, and to prevent you from missing some files when copying, we extract those files/configurations of the latest version of the **Chirpy** theme and the [CD][CD] workflow to here, so that you can start writing in minutes. + +## Prerequisites + +Follow the instructions in the [Jekyll Docs](https://jekyllrb.com/docs/installation/) to complete the installation of `Ruby`, `RubyGems`, `Jekyll` and `Bundler`. ## Installation -[Use this template][usetemplate] to generate a new repository, and then execute: +[**Use this template**][use-template] to generate a brand new repository and name it `.github.io`, where `GH_USERNAME` represents your GitHub username. -[usetemplate]: https://github.com/cotes2020/chirpy-starter/generate +Then clone it to your local machine and run: ``` $ bundle @@ -32,22 +35,12 @@ $ bundle Please see the [theme's docs](https://github.com/cotes2020/jekyll-theme-chirpy#usage). -## Upgrading - -First, please modify the target version number of `jekyll-theme-chirpy` in the `Gemfile` (e.g., `gem "jekyll-theme-chirpy", "~> 4.0", ">= 4.0.1"`). - -After that, execute the following command: - -```console -$ bundle update jekyll-theme-chirpy -``` - -As the version upgrades, the critical files and configuration options will change. Please refer to the [Upgrade Guide](https://github.com/cotes2020/jekyll-theme-chirpy/wiki/Upgrade-Guide) to keep your website files in sync with the latest version of the theme. - ## License This work is published under [MIT][mit] License. [gem]: https://rubygems.org/gems/jekyll-theme-chirpy [chirpy]: https://github.com/cotes2020/jekyll-theme-chirpy/ +[use-template]: https://github.com/cotes2020/chirpy-starter/generate +[CD]: https://en.wikipedia.org/wiki/Continuous_deployment [mit]: https://github.com/cotes2020/chirpy-starter/blob/master/LICENSE