Getting Started

아래의 설명은 Chirpy 원본 document에서 차용하였다.

Jekyll

가장 우선적으로 github에 repo를 생성하기 전에 jekyll 를 사용할 수 있는 환경을 조성하자. (Mac os 기준으로 설명)

Homebrew 통해서 rbenv, ruby-build 설치
1 $ brew install rbenv ruby-build
ruby, ruby-build에 대해서는 자세하게 알 필요는 없다. 필자도 정확하게 알지는 못한다. 다만 rbenv 통해서 여러 종류의 Ruby를 설치할 수 있게 지원한다. ruby-build라는 플러그인을 통해 설치 가능하고 이를 통해 다른 버전의 Ruby들을 임의의 디렉토리에 컴파일하고 설치할 수 있게 도와준다.

ruby 설치

  
 $ rbenv install -l    # 설치 할수 있는 버전 확인

 $ rbenv install 2.7.5 # 설치

 $ rbenv global 2.7.5 

 $ rbenv rehash 

 (base) ➜  ~ rbenv versions
   system
 * 2.7.5 (set by /Users/iganghui/.rbenv/version) # 최종적으로 설치한 버전에 *가 오면 된다

rbenv path 추가 (설정 하지 않으면 4번에서 에러 발생한다.)
시스템 상에도 Ruby가 존재하는데 방금 설치한 Ruby 버전에 접근할 수 있도록 수정한다.
1 $ open ~/.zshrc
아래 두줄 을 추가해준다.
1 2 export PATH={$Home}/.rbenv/bin:$PATH && \ eval "$(rbenv init -)"

gem 패키지 설치

  
$ gem install bundler
$ gem install jekyll

필요한 패키지들은 다 설치하였다. (혹시나 설치하다가 문제가 발생하였을 경우 다음의 파일들을 다 삭제해주면 된다.)

  
$ gem uninstall -aIx  # gem packages 다 지운다.
$ rm -rf ~/.bundle
$ rm -rf ~/.gem
$ rm -rf ~/.rbenv
$ brew uninstall rbenv ruby-build

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.
GitHub Fork - Convenient for custom development, but difficult to upgrade. Unless you are familiar with Jekyll and are determined to tweak or contribute to this project, this approach is not recommended.

Option 1. Using the Chirpy Starter

Sign in to GitHub and browse to Chirpy Starter, click the button Use this template > Create a new repository, and name the new repository USERNAME.github.io, where USERNAME represents your GitHub username.

Option 2. GitHub Fork

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

$ bash tools/init

If you don’t want to deploy your site on GitHub Pages, append option --no-gh at the end of the above command.

The above command will:

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

Installing Dependencies

Before running local server for the first time, go to the root directory of your site and run:

$ bundle

Usage

Configuration

Update the variables of _config.yml as needed. Some of them are typical options:

url
avatar
timezone
lang

Customizing Stylesheet

If you need to customize the stylesheet, copy the theme’s assets/css/style.scss to the same path on your Jekyll site, and then add the custom style at the end of it.

Starting with version 4.1.0, if you want to overwrite the SASS variables defined in _sass/addon/variables.scss, copy the main sass file _sass/jekyll-theme-chirpy.scss into the _sass directory in your site’s source, then create a new file _sass/variables-hook.scss and assign new value.

Customing Static Assets

Static assets configuration was introduced in version 5.1.0. The CDN of the static assets is defined by file _data/origin/cors.yml, and you can replace some of them according to the network conditions in the region where your website is published.

Also, if you’d like to self-host the static assets, please refer to the chirpy-static-assets.

Running Local Server

You may want to preview the site contents before publishing, so just run it by:

  
$ bundle exec jekyll s

Or run the site on Docker with the following command:

  
$ docker run -it --rm \
    --volume="$PWD:/srv/jekyll" \
    -p 4000:4000 jekyll/jekyll \
    jekyll serve

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 _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 starts with a slash, e.g, /project-name.

Now you can choose ONE of the following methods to deploy your Jekyll 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 Gemfile.lock to the repository, and your local machine is not running Linux, go the the root of your site and update the platform list of the lock-file:
1 $ bundle lock --add-platform x86_64-linux

Next, configure the Pages service.

Browse to your repository on GitHub. Select the tab Settings, then click Pages in the left navigation bar. Then, in the Source section (under Build and deployment), select GitHub Actions from the dropdown menu.
Push any commits to GitHub to trigger the Actions workflow. In the Actions tab of your repository, you should see the workflow Build and Deploy running. Once the build is complete and successful, the site will be deployed automatically.

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

Manually Build and Deploy

On self-hosted servers, you cannot enjoy the convenience of GitHub Actions. Therefore, you should build the site on your local machine and then upload the site files to the server.

Go to the root of the source project, and build your site as follows:

  
$ JEKYLL_ENV=production bundle exec jekyll b

Or build the site on Docker:

  
$ docker run -it --rm \
    --env JEKYLL_ENV=production \
    --volume="$PWD:/srv/jekyll" \
    jekyll/jekyll \
    jekyll build

Unless you specified the output path, the generated site files will be placed in folder _site of the project’s root directory. Now you should upload those files to the target server.