Recently, as an extension of my note-taking obsession, I decided to start this blog, primarily to share what I’ve learned the hard way. I already had my domain name registered via Namecheap (non-ref), so it was time to find hosting. Luckily, Github offers free hosting with support for Jekyll. Jekyll is a Ruby-based static site generator that authoring easy by automatically building Markdown files, but remains powerful enough to create all sorts of site customizations.
In this tutorial, I will walk you through the steps I took and the resources I used to build this blog, the first undertaking of its kind for me. There were many tools that made setup easy, but it was still enough work that it was a fun and enlightening process.
To begin with Github pages, you will have to create a repo on Github entitled yourname.github.io. This will be your URL if you don’t register a custom domain, but having your own domain is always nice. It takes just a few extra steps, but is worth it for the professional look it offers your site.
Setting Up Poole
The first step is to get Poole. This site uses the minimalist Lanyon theme, which keeps navigation in a collapsible sidebar. Poole on its own is described as a butler for Jekyll, which is really a great analogy: it provides a vanilla install of Jekyll, setting up many of the folders that Jekyll will use to generate your site. Follow the instructions at the Poole website to install the gemfile, then clone down the empty repository you made, go to the repo for the theme you want and download the provided archive. Extract that to your local repo and push it to your remote, and you’re all set with Poole!
Setting Up a Custom URL
Github offers two sets of instructions for setting up your domain depending on whether you are using an apex domain or subdomain. To set up the appropriate records with Namecheap specifically, navigate to the Manage Domains page, select the domain you wish to set the record for, and click the ‘Edit Selected’ button. Now, on the left navigation pane, click the ‘All Host Records’ link. On this page, you will need to set two
A records for hostname
@, one to
184.108.40.206 and the other
220.127.116.11. You will also need to set a
CNAME record for hostname
www to your Github Pages URL (in my case
When you have done this, all that is left is to edit the CNAME file (a blank one comes with Poole) to have your custom URL. Save the file and push it to your remote, and navigating to your blog via a custom URL should work shortly.
Setting Up Your Configuration
The main way to do basic configuration on your site is to edit your
_config.yml file in the root of your repo. Here, you can set the markdown engine, code highlighting engine, and more. These will allow you to leverage the liquid templating system and customize the sidebar later. For an example
_config.yml file, see my config.
Setting Up Your About Page
Poole comes with an example
about.md page that gives you a general idea of how to leverage Markdown for the content of your page. What you will also notice is some information at the top of the page. This is the YAML frontmatter, and gives Jekyll some important information about your page (or post) that it will use when generating your site. Here is the default frontmatter in
--- layout: page title: About ---
Layout specifies which specific layout to use (they are located in your
_layouts folder), in this case we are using a page layout, as opposed to a post layout. We can also specify the
title. I didn’t make any additional changes to the frontmatter here, the frontmatter is much more powerful (and useful) in the context of a blog post.
Open up your local
about.md in your favorite text editor if you haven’t already, and write something up! Now, I’m sure you don’t want to push every minor change to Github just to preview your changes, so instead of that fire up your Terminal and run
jekyll serve. This will allow you to access your generated website at
localhost:4000 and will rebuild your site when any file is changed so that you can quickly view any edits you make before publishing. Play around, and when you’re satisfied with your page, push it to your remote repo.
The primary difference between a post and a page is the location of a post (they will be put in your
_posts folder) and the filename, which will be the date followed by the title, e.g.
2015-04-06-sublime-markdown.md (for my excellent previous post). You can also take advantage of more YAML variables here, such as
category. Go ahead and write an introductory post and give it some tags! To preview your post, fire up your terminal, navigate to your local repo for the site, and run
jekyll serve. Like above, this command will build and serve your site, allowing you to view it at
localhost:4000. When you want to publish (you can go ahead and publish what you’ve written now, or write another post later), use git to
add your files to the staging area,
commit them, and then
push them to your remote repo.
Setting Up Drafts and .gitignore
Another handy feature is the ability to save drafts. Instead of saving a dated markdown file to the
_posts folder, save an undated markdown file (e.g.
ruby-blog-first-draft.md) to the
_drafts folder. In order to preview, run
jekyll serve --drafts. When you are ready to publish the post, rename it according to the convention above and move it to your
Before you push anything to your remote (and public) Github repo, it may be wise to create a
.gitignore file. Like the filename says, this file tells git which files to ignore so that they don’t show up in your public repo. Simply add the name of a specific file or files (by using asterisks as wildcards) to its own line. For a template, feel free to refer to my own .gitignore file. The most important thing for me was to not share my
_drafts folder, so that I could both keep my commits clean (and not have dozens of draft edits being pushed along with a major page overhaul) and to keep post ideas private until they are finished, polished, and ready for the world to see. Read more about
That is it for part 1 of this guide, please check back again soon for Part 2, where I will cover more customizations and other blogs that helped me set mine up.