My First Jekyll Website

12 Oct 2023 • Ke Yi

The way to establish this website.

1. Why did I establish this website?

I established this site to share some experience, including but not limited to experimental techniques, software use, etc..

I’m looking forward to making this site bigger someday :>

2. How did I establish this website?

The process of building this site is roughly divided into three steps: building the Jekyll environment, building the web framework, and deploying to Github.

2.1 Build Jekyll environment

I chose to use Jekyll and Github Pages to build this site.

First of all, Jekyll is based on a Ruby environment, and I used the Homebrew control tool Rbenv and installed Ruby through it.

P.S. Ruby version try to choose 2.7.2 version, such as version is too high part of the Jekyll template may not be compatible.

brew rbenv
rbenv install 2.7.2

Apply version 2.7.2 globally and source it to shell.

rbenv global 2.7.2
source ~/.zshrc

Further installing jekyll via gem allows you to start building the web framework.

gem install jekyll bundler

2.2 Creating a web framework

There are two main ways to build a web framework, Jekyll can directly build a minima theme website template.

jekyll new mywebsite

In addition, you can also fork existing templates. This site is mainly based on the Jekyll theme not-pure-poole

P.S. The following operations are need to cd to the Jekyll root directory first

When you fork the template, you should use bundle to install the gem used in the template before deploying the server for the first time, and then use the serve command to deploy the server locally.

//Install the gem
bundle install
//Deploy the server locally
bundle exec jekyll serve

Then you can access the local website at http://localhost:4000

2.3 Deploying to Github Pages

When debugging is complete, you can deploy to Github Pages via Github desktop.

First, you need to create a repository in the Github repository named (username).github.io, e.g. keyi926.github.io.

Clone the repository locally and copy the debugged website files to the Github directory, submit the update in Github Desktop and push it to Github server.

Then you can access the website via keyi926.github.io