How to set up a minimal Jekyll website with GitHub pages in 5 minutes

After spending a whole day (a few other tasks here and there) to set up this website, I think I owe it to the internet - a tutorial on how one can set up a website, just like this, in 5 minutes! So read on if you liked the way I’ve put together this website.

P.S.: This is my first blog post, ever…

Pre-requisites

  • A Unix based machine
  • A GitHub account; and subsequently, knowledge on how to use git.
  • Ruby
  • RubyGems

Deploy with GitHub Pages

The good guys at GitHub let you host your own static website on their servers through GitHub Pages. Just create a repository in your GitHub account with the name username.github.io (where username is your GitHub username) and you’re good to proceed.

Get Lanyon theme for Jekyll

Lanyon is an unassuming Jekyll theme that places content first by tucking away navigation in a hidden drawer. It’s based on Poole, the Jekyll butler.”

Enter these commands on the terminal in a directory of your choice after replacing username with your GitHub username:

GitHub will automatically deploy the sample Lanyon template to username.github.io! Your website is now live.

Install and run Jekyll locally

It really just takes one line to install Jekyll and all it’s dependencies:

… and another line to deploy it locally (when you’re in the website’s root folder):

After you run this, you can access your website locally at http://127.0.0.1:4000


Now you’re all set to tinker with your new website. Make sure you have a look at the Jekyll docs to unleash the full power of Jekyll.

comments powered by Disqus