HadiAsyrafi / HadiAsyrafi.github.io

Website for sharing/communicating my personal learning in Hardware Security

Chirpy Starter

The startup template for Jekyll Theme Chirpy.

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

The critical files/directories to run or build the Chirpy theme are as follows:

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

So we've extracted all the Chirpy gem necessary content here to help you get started quickly.

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.

Upgrading

First, please modify the target version number of jekyll-theme-chirpy in the Gemfile (e.g., gem "jekyll-theme-chirpy", "~> 4.0", ">= 4.0.1"). In addition, if the major version number is updated, you need to update the critical files to keep them the same as this project.

After that, execute the following command:

$ bundle update jekyll-theme-chirpy

Documentation

See the theme's docs.

License

This work is published under MIT License.