Github Pages

What is Github Pages? #

This is a feature provided by GitHub where you can host websites directly from your GitHub repository. These websites are typically static files, meaning there is no database no backend. For example, this website is hosted on GitHub Pages, it was built with a static site generator.

To find out more, go to

How to create your home page (easy way) #

When you use GitHub pages, you can access your website at the url and the underlying files would be found in your repository, which is the repository can be found at url pattern

This section walks you through step by step. These instructions are taken directly from GitHub’s docs.

Short version:

  1. Create a repo of name:
  2. Go to that repo’s settings and check the box for your pages (note the drop down option selected)
  3. Add .html files to your repo

You should be able to access your website from

Longer version:

  1. From your account, create a new repo with the name following the pattern where you use your username to replace the part that says yourusername – this is the basis for producing a website hosted by github pages (
  2. Confirm that the pages feature is turned on for that repository, under the settings menu.
  3. This allows you to host files under your GitHub account.
    1. You could use the web interface to upload each file individually, however I recommended you take time at some point in your career to gain familiarity with the workflow of using git commands from your machine terminal.
    2. Upload the images and html files to that repo.
  4. If set up properly you should be able to access your website from

Static Site Generators #

Static sites do not have a database backend, “data” is stored in text files. Data is used loosely here to mean contents of the site. Text files can often imply that they are markdown formatted files.

In order to translate text files into a website in a streamlined manner, you need some sort of tool to generate that website for you. This tool is called a static site generator. There are many Open Source static site generators available to choose from that go by different names. Some are produced in certain programming languages. They tend to require using the command line interface (CLI).

Below describes a couple of options.

Using Jekyll Static Site Generator #

Github Pages recognizes files that are formatted to the Jekyll Static Site Generated fraemwork. Jekyll ( is written in the Ruby programming language, it convers text files in markdown format into HTML pages.

Static HTML pages means that it’s an HTML page that doesn’t change when you view it across different timestaps. As in, static is not a script generated page. The contents do not change because you pull data from a database. A page like that would be considered dynamic because the contents can change.

Guides to using Jekyll #

The guides and tutorials for using Jekyll are easily found through your nearest search engine. These are some liks:

Using Hugo Static Site Generator #

The best reference material is the official documentation at

Once you have Hugo installed, make sure your files are organized in their proposed directory structure. Find a theme, configure your Hugo website.

Org-mode with Hugo #

This site is generated from the GNU Emacs program under the Org Mode. In order to use both pieces, you need to use one more open source plugin called ox-hugo

The contents are contained in *.org files instead of *.markdown or *.txt

References #

Intro to HTML/CSS #

Tutorials and Guides on deploying to GitHub Pages #