Github.io Zola Template

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.

Super duper simple process

1. Install Zola from its release page. Alternatively, you can install Zola from its repository, for more information, see my article.

2. Fork this repository and rename it to your own. For example: xxx.github.io, here xxx is your GitHub username.

3. Create a personal access tokens, and select all repo.

   

4. Go to your repository's settings page and update your token:

   

5. 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.

6. 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:

   

Configure your own style

• Go get a new theme from Zola's themes page. Update Makefile to use your theme (here I used DeepThought as my theme).

• Open config.toml file at the root of your repository, and replace all the xxx with your name.

• Provide your own icons and avatar under ./static directory.

You are ready to go

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.

References

• Zola
• How to use zola ...