Chirpy Starter Personal Website

The startup template for Jekyll Theme Chirpy.

When installing the Chirpy through RubyGems, 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 (use the command bundle info --path jekyll-theme-chirpy to locate). To fully use all the features of Chirpy, you also need to copy other critical files/directories from the theme's gem to your Jekyll site.

# The critical files/directories to run Chirpy theme
├── _data
├── _plugins
├── _tabs
├── _config.yml
├── app.js
├── feed.xml
├── index.html
├── robots.txt
├── sw.js
└── 404.html

We extracted all the necessary content of Chirpy theme's gem to help you quickly use the theme.

Installation

Use this template to generate a new repository, and then execute:

$ bundle

Usage

Customing Stylesheet

Creare a new file /assets/css/style.scss in your Jekyll site.

And then add the following content:

---
---

@import {{ site.theme }}

// add your style below

Changing the Number of Tabs

When adding or deleting files in the _tabs folder, you need to complete the section Customing Stylesheet first, and then add a new line before @import:

$tab-count: {{ site.tabs | size | plus: 1 }};

Publishing to GitHub Pages

See the deployment instructions of jekyll-theme-chirpy.

Updating

Please note that files and directories in this project may change as the jekyll-theme-chirpy is updated. When updating, please ensure that the file directory structure of your Jekyll site is the same as that of this project.

And then execute:

$ bundle update jekyll-theme-chirpy

Documentation

See the theme's docs.

License

This work is published under MIT License.