Github pages supports jekyll, a static blog generator written in Ruby.
I got this blog template after I read a blog post about deep learning. And here are the steps.
Requirements installation
Firstly, you'll need Ruby installed. I use Ruby Version Manager (some people prefer rbenv). A basic RVM installation should come with Rubygems, the ruby packaging system and bundler, a tool to locally manage your gems.
You should check your installed versions. Currently I'm using:
Ruby:
$ ruby --version ruby 2.2.2p95 (2015-04-13 revision 50295) [x86_64-darwin14]
Gem:
$ gem --version 2.4.8
Bundler:
$ bundle --version Bundler version 1.10.6
Jekyll installation
All you need to install jekyll is a Gemfile (i.e. a text file named Gemfile) with the following lines:
source 'https://rubygems.org'
gem "jekyll"But I got a sample installation by cloning Clean Blog.
To install the packages, just go to the directory where Gemfile is and run
$ bundle install --path .bundle
Bundler makes a local environment for your gems, so you don't have to globally install packages (and mess with your system). Also for production, normally you don't have access or don't want to install ruby gems globally. So I always use bundler.
The --path parameter should point to any dot-name (like .bundle) because jekyll tries to compile itself if it's on its way (any subdirectory the blog has) and issues an error.
And take look at the versions:
$ bundle exec jekyll --version jekyll 3.2.1
I believe that listing the versions now will help myself in the future :-)
Writting
Jekyll has it’s conventions for generating posts. Basically, your files should be named YEAR-MONTH-DAY-title.MARKUP inside the _posts directory. For instance, this blog post’s source is at _posts/2019-09-01-running-jekyll.markdown.
To run locally before pushing to github:
$ bundle exec jekyll serve --watch
And it opens a local server on port 4000 with the contents.
More information
You just should read jekyll’s documentation.