Bye, Wordpress!

January 9, 2021
blog github hugo

Last summer, frustrated over the loss of my personal domain, I bought a cute url and set up a Wordpress blog with the intention of sharing some content about what I was working on. Our son was born around the same time and so the site sat idle for a few months, but when I picked up writing back in November, the experience with Wordpress irked me. Wordpress is a fine CMS, it is great for getting a quick blog up and going, but I wanted more control over my content.

Recently, much to my surprise, I was able to re-register and that inspired me to move my site and finally ditch Wordpress.

Being a software engineer, writing in Markdown and using a Git repository as a home for my content is more natural than using an opaque CMS. With that as a basis, there are some surprisingly simple methods for setting up a website / blog. GitHub Pages offers basic (and free!) hosting from a Git repo. It can be configured to serve on custom hostnames and it even handles SSL! ✔️

To get content in Markdown served up as HTML, GitHub Pages uses Jekyll, an HTML generator written in Ruby, but with a little bit of work, Hugo, the ‘static-site-generator-du-jour’, can also be used.

So, in the span of an evening of tinkering, I now have the following setup:

I’m not super happy with the looks of the site yet, but that’s a matter of toying around with Hugo Themes. The important thing is that the setup works and that my content is fully in my control. 🎉

Hope that was useful, and as they say, watch this space.


render-md-mermaid, a GitHub Action

January 31, 2021
Earlier, I wrote about rendering Mermaid graphs in Markdown on GitHub by invoking a script, possibly using a make target to cover all Markdown files in an entire repository. Since then I’ve used Mermaid diagrams and the script presented in that post in docs for a couple of projects. While the script works great, having to remember to run it or plumb client side automation to do so automatically can be a bit of a hassle...

mermaid markdown github

Rendering Mermaid graphs in Markdown on GitHub

January 20, 2021
When writing documentation for software, sooner or later you’re going to hit the point at which a picture will explain in a glance what you would have a hard time describing in the proverbial “thousand words”. While documenting something technical, this usually means diving into the drawing section of whatever editor you’re using and wrangling with lines and boxes until you’re satisfied with your masterpiece or you’ve exhausted your patience with the tool...

make mermaid markdown github