TODO

• Posts
  • D&D app
  • Blog on DNS records
  • HTB Tier 3 Content
  • CWEE
  • Web Cache Vuln Demo
  • HTB machine submission
  • Common mistakes

Organizational notes for self

• The Chirpy Starter splits content between the root project directory and the corresponding gem (jekyll-theme-chirpy*).
  • Content/folders placed into the root directory override what's in the theme.
• The assets directory contains:
  • images: which hosts images accessible site-wide
  • img: which hosts the requisite favicon information
• The _includes directory was updated to include footer.html so as to override the Jekyll default footer.
• The _layouts directory was copied from the gem theme and altered to include Google Analytics code.
  • Chirpy's default configuration was designed for UA, which became deprecated in July 2023
• Went through and updated instances of http:// to https:// to mitigate mixed-content errors.

Chirpy Starter

 

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.

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.

sudo apt update && sudo apt upgrade -y sudo apt install ruby-full build-essential zlib1g-dev -y sudo bundle install bundle exec jekyll serve

License

This work is published under MIT License.