Getting Started

This is work in progress.

Here comes the sun

Follow the instructions in the Jekyll Docs to complete the installation of the basic environment. Git also needs to be installed.

Installation

Creating a New Site

There are two ways to create a new repository for this theme:

• Using the Chirpy Starter - Easy to upgrade, isolates irrelevant project files so you can focus on writing.

Option 1. Using the Chirpy Starter

Sign in to GitHub and browse to [Chirpy Starter][starter] click the button Use this template and name the new USERNAME

Option 2. GitHub Fork

Sign in to GitHub to fork Chirpy.

Next, clone your site to local machine. In order to build JavaScript files later, we need to install [Node.js][nodejs], and then run the tool:

$ bash tools/init

The above command will:

1. Check out the code to the [latest tag][latest-tag] (to ensure the stability of your site: as the code for the default branch is under development).
2. Remove non-essential sample files and take care of GitHub-related files.
3. Build JavaScript files and export to assets/js/dist/, then make them tracked by Git.
4. Automatically create a new commit to save the changes above.

Usage

Configuration

Update the variables:

• url
• avatar
• timezone
• lang

Running Local Server

After a few seconds, the local service will be published at http://127.0.0.1:4000.

Deployment

Before the deployment begins, check out the file project site

Deploy by Using GitHub Actions

There are a few things to get ready for.

• If you’re on the GitHub Free plan, keep your site repository public.
• If you have committed

At this point, you can go to the URL indicated by GitHub to access your site.

Manually Build and Deploy