Tutorial on Chirpy

Customize the Favicon

Sun, 11 Aug 2019 00:34:00 +0800

The favicons of Chirpy are placed in the directory assets/img/favicons/. You may want to replace them with your own. The following sections will guide you to create and replace the default favicons.

Generate the favicon

Prepare a square image (PNG, JPG, or SVG) with a size of 512x512 or more, and then go to the online tool Real Favicon Generator and click the button Select your Favicon image to upload your image file.

Getting Started

Fri, 09 Aug 2019 20:55:00 +0800

NOTE: This tutorial is not fully migrated from the Jekyll version – please reference with caution.

Creating a Site Repository

When creating your site repository, you have two options depending on your needs:

Option 1. Using the Starter (Recommended)

This approach simplifies upgrades, isolates unnecessary files, and is perfect for users who want to focus on writing with minimal configuration.

Sign in to GitHub and navigate to the starter.
Click the Use this template button and then select Create a new repository.
Name the new repository <username>.github.io, replacing username with your lowercase GitHub username.

Option 2. Forking the Theme

This approach is convenient for modifying features or UI design, but presents challenges during upgrades. So don’t try this unless you are familiar with Jekyll and plan to heavily modify this theme.

Writing a New Post

Thu, 08 Aug 2019 14:10:00 +0800

This tutorial will guide you how to write a post in the Chirpy template, and it’s worth reading even if you’ve used Hugo before, as many features require specific variables to be set.

Naming and Path

Create a new file using hugo new content/post/YYYY-MM-DD-TITLE.md. You can change the path as you like, but note that all the posts should be placed in content/post of the root directory.

Front Matter

Basically, you need to fill the Front Matter as below at the top of the post: