There is a lot of information on the Internet about the process of creating Github Pages website using Jekyll.

I’ve gone through this process recently, so I found some interesting resources that can help on that matter:

  1. The theme of my website. Why exactly this:
    • It’s very simple - no excessive elements, animations, and so on. Information is the center of attention;
    • Nice font;
    • Easy for setting and managing. I don’t want to learn HTML/CSS and a lot of other stuff to make things work.
  2. This website was supposed to contain equations, but, unfortunately, they didn’t work out of the box:
    • Only one guide helped me render equations on the pages. If you also suffer from these issues, please check the github repo of the site. Most of the work should be done in the _config.yml and Gemfile files.
    • It could be useful to check the official documentation about Katex. At least check displayMode option, because it defines how you will see your equations.
    • Don’t forget about the list of supported functions for Katex. You will find what you should type for various symbols in your equations.
  3. This website contains some code examples, so syntax highlighting is very essential for me:
    • It seems like the default syntax highlighter is quite good and supports a wide range of languages.
    • If you are going to write some kind of pseudocode, I guess Java is your choice.
    • If the default syntax highlighter is not what you’re looking for, try the rouge syntax highlighter.
  4. If you have problems with favicon (it’s not displaying), check this stackoverflow page.
  5. And last but not least, index your page on Google using the Google Search Console:
    • It can be useful to create a site map; I used XML-Sitemap.com for this. But Google indexes my website very slowly. I guess because it’s very young.

Good luck with your website!