Skip to content

README.md

Latest commit

 

History

History
74 lines (49 loc) · 2.86 KB

README.md

File metadata and controls

74 lines (49 loc) · 2.86 KB

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 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.

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.

Usage

Check out the theme's docs.

Contributing

This repository is automatically updated with new releases from the theme repository. If you encounter any issues or want to contribute to its improvement, please visit the theme repository to provide feedback.

License

This work is published under MIT License.

Setting up the Environment

Setting up Natively (Recommended for Unix-like OS)

For Unix-like systems, you can set up the environment natively for optimal performance, though you can also use Dev Containers as an alternative.

Steps:

  1. Follow the Jekyll installation guide to install Jekyll and ensure Git is installed.
  2. Clone your repository to your local machine.
  3. If you forked the theme, install [Node.js][nodejs] and run bash tools/init.sh in the root directory to initialize the repository.
  4. Run command bundle in the root of your repository to install the dependencies.

Usage

Start the Jekyll Server

To run the site locally, use the following command:

$ bundle exec jekyll serve --livereload --drafts --force_polling --incremental

After a few seconds, the local server will be available at http://127.0.0.1:4000.

commit

$ git add . && git commit -S -m 'YOUR_MESSAGE'