This site is generated with Jekyll, which is “blog aware”. I guess that means I should have a blog here. In keeping with the tradition of DIY technology projects, I’m going to start by using it to write about itself, mostly so that I don’t forget what I did.
Who is this for?
Besides me, that is. If you follow these instructions, you’ll end up with a site that:
- Is under source control with git
- Is made of static files, delivered by a CDN that should provide good speed and uptime
- Has repetitive parts generated from structured text files by templates
- Does not require and databases or servers
- Is free, unless you want your own second-level domain name
- Configuration is minimal with no manual upgrades on the server-side required
This comes at some cost in flexibility:
- Everything on the site is public
- TLS isn’t supported
- You don’t have CGI, SQL, shellshock, etc. support
The bottom line is that these instructions are for publishing public documents, not programming or doing the kinds of fine-gained setups that you’d want a CMS for.
We’re going to go through the steps to get the site’s skeleton up and running in a way you can edit it. The steps are serialized into an order that works.
1. Install Jekyll
The tool used to actually generate the site is Jekyll. This is itself a wrapper around some useful utilities. Installing it is very easy:
$ gem install jekyll
2. Get set up with GitHub
Next you’ll want a GitHub account. If you don’t have one, go make one now.
Once you’ve done that, download the GitHub app for Mac. Open it and log in with your github username.
If you are using Linux, skip this step and then use the command line where I say to use the app below.
3. Create a minimal site
In the app, select “New Repository” from the file menu. The name of the new repository should be
username is your GitHub account. Pick someplace to put the files,
which we’ll call
REPO. For now, don’t put anything there. Now
open up a terminal and do
$ cd REPO
$ git pull https://github.com/theran/theran.github.io.git template
Keep this terminal open and in the same directory.
_config.yml to include your name and the associated information.
Then, in the command line again do
$ jekyll serve
You should see an empty site at http://localhost:4000/. This is where you’ll test new edits out. To get going you will want to:
contact.mdto have your contact information.
bio.mdto have your brief bio
- Put a picture of yourself in
_includes/picture.htmlto point at the picture you added and show your address
CV.htmlto have your actual data
- Put your papers into
_papers/. (For the moment, just see https://github.com/theran/theran.github.io/tree/master/_papers for the format. Don’t forget to add journals, conferences, and coauthors in
As you edit, Jekyll will keep rebuilding, so you can see how it looks at http://localhost:4000/.
4. The publishing workflow
Once you are happy with what you have, go back to the GitHub app. Click “Commit” and then “Sync” (at the top right). Wait a minute, and you’ll have a web site at http://username.github.io/.
From now on, the editing and publishing cycle is:
- Start Jekyll with
- Edit or add files, testing in your browsers at http://localhost:4000/
- When you are ready to publish, just do commit in the GitHub app and then Sync
5. Get a domain name
These next two steps are optional. If you want your own domain name and don’t have one, first you have to buy it. I recommend to do this with http://iwantmyname.com.
Next you need to tell GitHub about your domain name. To do this, on the command line run
$ cd REPO
$ echo yourdomain.example > CNAME
Then commit and sync the new file.
6. Get better DNS hosting
If you did already have a domain and aren’t using it for email go on. Otherwise, you should stop here and add records to your existing zone. (I don’t know your configuration, so I won’t be too helpful.)
Next, you’ll need to set up your new domain to point at GitHub. For rather opaque reasons, a lot of DNS providers will give quite poor performance. To get around this, you’ll need an account at CloudFlare. Go get one. Pick free and take the default options.
Once you’ve got the CloudFlare account, it will ask you to
add a web site. Type in
yourdomain.example. It will
import any DNS records you have for your zone. Delete all
Now in the CloudFlare control panel add a
@ to point to
username.github.io. If you
want, also add a
CNAME record for
www to also
username.github.io. For both of these records
click the orange cloud to make it “off CloudFlare”. It will
turn gray. (GitHub is giving you similar features already.)
Finally, look to the right side of the CloudFlare panel above. It lists two name servers. Go back to your DNS registrar’s control panel (e.g., at http://iwantmyname.com) and paste these into the “set name servers” field, deleting any other name servers.
Wait until everything updates at DNS World HQ, and then your new URL http://yourdomain.example/ will point to your new site.