A simple template for writing GitHub.io pages.
I've tried my best to recall all the steps I made while creating and deploying my own blog, but still there might be some missing steps or vague points, please feel free to leave an issue if you have any questions.
-
Install Zola from its release page. Alternatively, you can install Zola from its repository, for more information, see my article.
-
Fork this repository and rename it to your own. For example:
xxx.github.io
, herexxx
is your GitHub username. -
Create a personal access tokens, and select all repo.
-
Go to your repository's settings page and update your token:
-
Move
depoly.yml
to the.github/workflows
directory. This is the file that will be used to deploy your site. For more information, please visit Zola's deployment guide here. -
Go to your GitHub repository and create a new branch named
gh-pages
. And then, go to the settings page to setup 'source' as following:
-
Go get a new theme from Zola's themes page. Update
Makefile
to use your theme (here I usedDeepThought
as my theme). -
Open
config.toml
file at the root of your repository, and replace all thexxx
with your name. -
Provide your own icons and avatar under
./static
directory.
Now you can create your own markdown files in ./content/docs
and ./content/posts
directories. And each time you push your changes to GitHub, Github Actions will automatically deploy your site.