Build a Personal Website in Jekyll - A Detailed Guide For First-Timers
Article Table of Contents
- Intended audience:
- Output and expected results
- 1. Get started with basic jekyll/theme combination
- 2. Learn the basics of how Jekyll works, so you can customize it to your liking
- 3. Set up github repo to host your site
- Additional resources
You’re a turing student, in the backend program.
You know Ruby, you wanna start blogging, but everyone who says
go start a blog
Seems to also think you have 10 hours (or 20 hours? or 2 hours? how long does this take) to sit around dealing with setting up a personal website.
Lets set one up.
Intended audience: #
Turing Mod 1 backend student, or ambitious mod-0 student
Output and expected results #
Have a basic site online, at
your-github-username.github.io that looks professional enough you could share it with a future employer, but puts the main emphasis on your words, not the flashyness of the page or complexity of the technology.
My website (the one you’re reading on right now) looks pretty simple, and I know how to set it up, so we’ll start with setting up something similar to my website, and I’ll show you how to use different templates as well.
1. Get started with basic jekyll/theme combination #
Head to https://github.com/poole/poole, and hit the
clone or download url.
In your terminal, make a new dirctory, perhaps in your pre-existing
$ cd ~/turing # Here's we're cloning the repo, but placing it inside of a folder _we_ define name $ git clone <url from that `poole` repository> jekyll-site $ cd jekyll-site $ bundle install # if `bundle install` throws error, do `gem install bundler`, then re-try `bundle install` $ bundle exec jekyll serve
Now the server should be running.
Now, in a web browser, visit the given url:
Sidebar - what the heck is Jekyll? How does this thing turn into a website that people can visit? #
great question! Holy cow.
Jekyll’s documentation assumes a strong knowledge of how the internet works.
Transform your plain text into static websites and blogs
What does this mean? What’s a “static site generator”? Why do some people even care so much?
more to come soon
2. Learn the basics of how Jekyll works, so you can customize it to your liking #
Lets figure out the important parts of this new directory.
.yml extension stands for “Yaml Ain’t Markup Language”, which is the punchline to a joke.
.yml is format common in Ruby for writing machine-readable setttings that are equally easy for humans to understand. So, your Jekyll site will use this file to set basic settings, but it’s easy for you to modify the values yourself.
Here’s the first two changes you should make on your site:
Look at lines 2 and 3 in my editor - try making those changes, then make them show up in your browser. Don’t forget to restart your server! (hit
ctrl-r to kill it.)
3. Set up github repo to host your site #
From github’s instructions:
Head over to GitHub and create a new repository named username.github.io, where username is your username (or organization name) on GitHub.
If the first part of the repository doesn’t exactly match your username, it won’t work, so make sure to get it right.
Once you’ve done that, clone the repository:
git clone https://github.com/username/username.github.io
In that new directory, you’ll need to place your Jekyll site. If you want to keep working with the
poole theme we’ve worked with, you will need “connect” your Jekyll site locally to this new repository.
Lets first create a new directory at the root of your laptop for your website.
mkdir ~/your-github-username.github.io cd your-github-username.github.io mv ~/turing/jekyll-site .
Now, lets connect your github repo to this repository:
$ git init $ git add . $ git commit -m "Initial commit" $ git remote -v # should come back empty $ git remote add origin <your clone-this-repo url from above> $ git push origin master
And, when you visit that URL, you should see all your files up there!
Customizing your new jekyll site #
I’d recommend setting up a very basic landing page. It’s what my home page looks like, and it’ll probably work for you.
Then delete all that stuff, and make it your own:
Then fill it out and make it your own!
Here’s what I might write, if I were doing this for myself:
And here’s how it would look running locally:
I didn’t like how large the headings were, so instead of H1s (
#), I went with H2:
## before each section.