Switching to Jekyll
Article Table of Contents
- Why I switched to Jekyll
- What is Jekyll?
- Initial Resources I used to start
- Additional resources I’ve made use of since 2017
- Misc other notes
Why I switched to Jekyll #
A few days ago, I was really feeling the urge to write a short little blog post. So, I put it in a gist on Github.
I’m an advocate of writing publicly, and making it a habit, so why was I putting it in a gist, instead of here, on my website, where I theoretically can write and publish anything I want?
Friction
It’s very easy for me to sketch out a quick document with embedded screenshots in a text editor. I spend most of my day in a text editor anyway, so it’s trivially easy to write a new document.
I can add code snippets, links, images, and have nicely formatted text, just the way that I like it, in a gist.
SquareSpace, the service I was using for my website, is not designed for people who write in Markdown. SquareSpace is very good at many things, but not the things I needed. Practically Efficient says it better than I can.
So, last week, I decided that if I didn’t make my writing and publishing easy, I would probably just stop writing.
What is Jekyll? #
Jekyll is a “blog-aware static site generator that can run on Github Pages” (source).
All of these check off the “nice-to-have” boxes I’d look for. And now that I’m spending all day writing code, and inside of a text editor, and using Github, getting to merge my Git workflow with blogging is sorta perfect.
Plus, Jekyll is written in Ruby, so it has lots of pieces I’m quite familiar with by now.
I pulled from lots of articles others had written, to figure out all sorts of little tweaks. Here’s the list that I drew most heavily from:
Initial Resources I used to start #
- Using the Poole theme
- Enabling SSL connections with Github pages and a custom domain
- setting up reasonable post short-links
- Add email subscription box to jekyll blog
- Google Analytics setup for Jekyll
- Add and manage post excerpts
- Ruby script to parse SquareSpace XML archive into Jekyll-friendly posts (with images!)
- Adding “related posts” tool (I’m not currently satisfied w/my current implementation)
- Add meta description in Jekyll posts (This is the commit where I added it, if the above directions caused you some confusion too)
And that’s about it. It’s been an amazing experience, porting everything over to Jekyll.
There are still some modifications I want to make, like how code snippets run off the edge of the page if the lines are long, but this is lower priority.
There’s still plenty for me to learn with Jekyll, but I’m getting there.
Until then, I’ll probably be posting a lot more online. Since it’s so easy.
Additional resources I’ve made use of since 2017 #
Since switching to Jekyll in 2017, I’ve made additional changes. I’ll list useful resources here as I go.
- Jekyll Pure Liquid Table of Contents Auto-generate Table of Contents, no javascript required. So nice.
- Jekyll Pure Liquid Heading Anchors
Misc other notes #
I recently made this gist to help mod 1 backend Turing students get up and running on Jekyll. I’ll convert that gist to a proper page on my website soon.