Fork Chirpy on GitHub, and clone the fork to local by:
1 $ git clone email@example.com:<username>/jekyll-theme-chirpy -b master --single-branch
Setting up the local envrionment
If you would like to run or build the project on your local machine, please follow the Jekyll Docs to complete the installation of
Before running or building for the first time, please complete the installation of the Jekyll plugins. Go to the root directory of project and run:
1 $ bundle install
bundle will automatically install all the dependencies specified by
What’s more, in order to generate some extra files (categories, tags and last modified list), we need to use some tool scripts. If your machine is running Debian or macOS, make sure that GNU coreutils is installed. Otherwise, install by:
$ sudo apt-get install coreutils
$ brew install coreutils
Running Chirpy requires some extra files, which cannot be generated by Jekyll native commands, so please strictly follow the methods mentioned below to run or deploy your website.
Go to the root directory of the project and start initialization:
1 $ bash tools/init.sh
If you not intend to deploy it on GitHub Pages, append parameter option
--no-ghat the end of the above command.
What it does is:
- Remove some files or directories from your repository:
- everything under
- files under
Unless the option
--no-ghwas enabled, setup the GitHub action workflow by renaming
- Automatically create a commit to save the changes.
Generally, go to
_config.yml and configure the variables as needed. Some of them are typical options:
You may want to preview the site contents before publishing, so just run it by:
1 $ bash tools/run.sh
Then open a browser and visit to http://localhost:4000.
Few days later, you may find that the file changes does not refresh in real time by using
run.sh. Don’t worry, the advanced option
--realtime) will solve this problem, but it requires fswatch to be installed on your machine.
Before the deployment begins, checkout the file
_config.yml and make sure the
url is configured correctly. Furthermore, if you prefer the project site and don’t use a custom domain, or you want to visit your website with a base url on a web server other than GitHub Pages, remember to change the
baseurl to your project name that starting with a slash. For example,
Assuming you have already gone through the initialization, you can now choose any of the following methods to deploy your website.
Deploy on GitHub Pages
For security reasons, GitHub Pages build runs on
safe mode, which restricts us from using tool scripts to generate additional page files. Therefore, we can use GitHub Actions to build the site, store the built site files on a new branch, and use that branch as the source of the Pages service.
Push any commit to
origin/masterto trigger the GitHub Actions workflow. Once the build is complete, a new remote branch called
gh-pageswill appear, which is used to store the built site files.
Unless you prefer to project sites, rename your repository to
gh-pagesas your GitHub Pages source.
Visit your website at the address indicated by GitHub.
Deploy on Other Platforms
On platforms other than GitHub, e.g. GitLab, we cannot enjoy the convenience of GitHub Actions. However, we have a tool to make up for this shortcoming.
Commit the changes of your repository first, then run the publish script:
1 $ bash tools/publish.sh
Please note that the Recent Update list requires the latest git-log date of posts, thus make sure the changes in
_postshave been committed before running this command.
It will automatically generates the Latest Modified Date and Categories / Tags page for the posts and submit a commit, then push to
origin/master. Its output is similar to the following log:
1 2 3 4 [INFO] Success to update lastmod for 4 post(s). [INFO] Succeed! 3 category-pages created. [INFO] Succeed! 4 tag-pages created. [INFO] Published successfully!
Lastly, enable the pages service according to the instructions of the platform you choose.
Deploy on Private Server
In the root of the source project, build your site by:
1 $ bash tools/build.sh -d /path/to/site/
The generated site files will be placed in the root of
/path/to/site/. Now you should upload those files to your web server, such as Nginx.