pixx/chirpy-starter
Template
1
0
Fork 0
mirror of https://github.com/cotes2020/chirpy-starter.git synced 2026-06-07 07:17:57 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update readme

Browse Source
This commit is contained in:
Cotes Chung
2026-03-28 09:40:46 +08:00
parent 92429f5f77
commit 7ad088be90
1 changed files with 6 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@@ -3,16 +3,13 @@
[![Gem Version](https://img.shields.io/gem/v/jekyll-theme-chirpy)][gem]  [![Gem Version](https://img.shields.io/gem/v/jekyll-theme-chirpy)][gem] 
[![GitHub license](https://img.shields.io/github/license/cotes2020/chirpy-starter.svg?color=blue)][mit] [![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 A minimal, ready-to-use template for creating a blog with the [**Chirpy**][chirpy] Jekyll theme. Get up and running in minutes with all critical files pre-configured.
`_data`, `_layouts`, `_includes`, `_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 Jekyll team claims that this is to leave the ball in the user’s court, but this also results in users not being ## Why This Starter Exists
able to enjoy the out-of-the-box experience when using feature-rich themes.
To fully use all the features of **Chirpy**, you need to copy the other critical files from the theme's gem to your When installing Chirpy through [RubyGems.org][gem], Jekyll can only read a subset of theme files (`_data`, `_layouts`, `_includes`, `_sass`, `assets`) and limited `_config.yml` options from the gem. As a result, users cannot enjoy the full out-of-the-box experience that Chirpy offers.
Jekyll site. The following is a list of targets:
To unlock all features, the following files must be present in your Jekyll site:
```shell ```shell
. .
@@ -22,8 +19,7 @@ Jekyll site. The following is a list of targets:
└── index.html └── index.html
``` ```
To save you time, and also in case you lose some files while copying, we extract those files/configurations of the This starter bundles those files from the latest **Chirpy** release along with a [CD][CD] workflow, so you can start writing immediately.
latest version of the **Chirpy** theme and the [CD][CD] workflow to here, so that you can start writing in minutes.
## Usage ## Usage