Zhenhui's Blog

Guide to set up Github Pages by Pelican

This Github Page is built for display further projects. I use Pelican to simplify the process of creating html files. The following codes is referred to the tutorial on Github Pages and Pelican Doc.

Create a github repository and name it after by zhenhuixu.github.io. This repository will contain the html files that Pelican contains.
Install Pelican via pip.

pip install pelican

Clone the github repository I have just created.

git clone https://github.com/zhenhuixu/zhenhuixu.github.io.git

Run Pelican quickstart command to initialize. Set URL prefix to http://zhenhuixu.github.io and uploaded mechanisms to Github Pages.

pelican-quickstart

Convert the text file into HTML via the pelican command.

pelican ./content -s pelicanconf.py

Serve the output at http://localhost:8000. Check whether the html file is created correctly.

pelican --listen

Push the changes in the repository(output files).

git add .
git commit -m "This is the first homework"
git push -u origin master

Check the outcome on the Github Pages.

links

social