The startup template for Chirpy.
Go to file
2024-01-10 18:13:49 +00:00
_data Update critical file(s) according to Chirpy v6.3.0 2023-11-10 12:16:23 +00:00
_plugins Init commit 2021-01-26 05:13:40 +08:00
_posts Init commit 2021-01-26 05:13:40 +08:00
_tabs Update critical file(s) according to Chirpy v6.0.0 2023-05-16 19:05:24 +00:00
.github/workflows build(deps): specify the minor version number of ruby (#15) 2023-12-28 17:03:08 +08:00
assets Update critical file(s) according to Chirpy v6.4.0 2024-01-10 15:12:49 +00:00
_config.yml Update critical file(s) according to Chirpy v6.4.0 2024-01-10 15:12:49 +00:00
.editorconfig Update critical file(s) according to Chirpy v5.6.0 2023-03-17 18:23:14 +00:00
.gitattributes Init commit 2021-01-26 05:13:40 +08:00
.gitignore Update critical file(s) according to Chirpy v5.6.0 2023-03-17 18:23:14 +00:00
.gitmodules Update critical file(s) according to Chirpy v5.1.0 2022-02-14 17:30:02 +00:00
.nojekyll Update critical file(s) according to Chirpy v4.3.3 2021-10-24 20:18:05 +00:00
Gemfile Update critical file(s) according to Chirpy v6.4.1 2024-01-10 18:13:49 +00:00
index.html Init commit 2021-01-26 05:13:40 +08:00
LICENSE Init commit 2021-01-26 05:13:40 +08:00
README.md Update critical file(s) according to Chirpy v6.2.0 2023-09-10 13:24:09 +00:00

Chirpy Starter

Gem Version  GitHub license

When installing the Chirpy theme through RubyGems.org, Jekyll can only read files in the folders _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 users court, but this also results in users not being 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 Jekyll site. The following is a list of targets:

.
├── _config.yml
├── _plugins
├── _tabs
└── index.html

To save you time, and also in case you lose some files while copying, we extract those files/configurations of the latest version of the Chirpy theme and the CD workflow to here, so that you can start writing in minutes.

Prerequisites

Follow the instructions in the Jekyll Docs to complete the installation of the basic environment. Git also needs to be installed.

Installation

Sign in to GitHub and use this template to generate a brand new repository and name it USERNAME.github.io, where USERNAME represents your GitHub username.

Then clone it to your local machine and run:

$ bundle

Usage

Please see the theme's docs.

License

This work is published under MIT License.