Developing

How to compile

1. Install docker (Docker Desktop on Windows)
2. Install VS Code and Dev Containers extension
3. Clone repo and open it on VS Code using Dev Containers: Open folder in Container option
4. Execute next command. After few secnds, local server will be available at http://127.0.0.1:4000.

$ bundle exec jekyll s

Config

You can customize this page updating the variables in _config.yml file.

Chirpy creators information

 

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

Here's the fully documentation by the creators of this jekyll site: Check out the theme's docs.

License

This work is published under MIT License.