Back

Migrate Wordpress to Hugo

How I got rid of Wordpress and used Hugo for static content generation

Last modified:

Introduction

I’m annoyed by constant update notifications of wordpress. Plugins need also often updates and you’ve probably read about security issues as well. After retweeting this tweet

Kris answered me

and recommended to use Jekyll or Hugo. So I was motivated to finally make the switch. It took me a good week to get the page finally online on 01/06/2022.

Export from Wordpress

The data from Wordpress can either be pulled from an exported file or from a live connection to the database. Since I wanted the easy way, I’ve selected using a plugin and files.

Plugin

Install this plugin in your Wordpress installation. Its quite simple. You just have to install it and open the plugin settings for download.

Wordpress Import in Jekyll

My first try with a static content creator was Jekyll which is written in Ruby. I’ve gave it a short try but wasn’t too happy with the exiting themes.

Jekyll Import in Hugo

Import from Jekyll can be done with Hugo and without the need for any plugin. Take the archive, that was exported by the wordpress to jekyll plugin and extract it in one folder, e.g. blog/jekyll. Create a second folder called blog/hugo which will store the hugo files.

Now run hugo import jekyll blog/jekyll blog/hugo.

Adding a theme

I’ve decided to use the stack theme and customized it to my needs.

This theme has a back button, once it detects a markdown structure it can use in a table of content on the right side. For this, I had to manually modify all posts to introduce a first level heading with at least two second level headings. Otherwise the back button would have not been displayed. I’m not happy with this yet, but its working for now.

Install this by following the instructions. It depends if you’ve already used a git repo as target folder for your hugo import or if it was a blank folder.

Check the config.yaml

The config.yaml is the central configuration file for Hugo. Here you can setup the new theme among other options. This is my config.yaml:

baseURL: https://centurio.net
disablePathToLower: true
languageCode: en-us
title: Centurios Blog
theme: "stack"

params:
  rssFullContent: true
  article:
    toc: true
    readingTime: true
  comments:
    enabled: false
  sidebar:
    subtitle: Macs, Linux, IoT and Photography
    avatar:
      enabled: true
      local: true
      src: img/avatar.png
  widgets:
    enabled:
      - search
      - categories
      - archives
      - tag-cloud
    archives:
      limit: 5
    tagCloud:
      limit: 10
    categoriesCloud:
      limit: 20

menu:
    main:
        - identifier: github
          name: GitHub
          url: 'https://github.com/rudelm/'
          params:
            icon: github
            newTab: true
            
        - identifier: twitter
          name: Twitter
          url: 'https://twitter.com/rudelm'
          params:
            icon: twitter
            newTab: true

Running for the first time

Start hugo with hugo server -D and open a browser on http://localhost:1313. If something is wrong (e.g. wrong formatted yaml in the config.yaml), it won’t start up and notifies you. Be aware that things might look strange, depending on your import.

Location of blog posts

Blog posts are put into the content/post folder. The filenames are index.md. I recommend putting these to content/post/YYYY/MM/DD/post-title, because it will enable cool stuff like image processing.

Location of imported wp-content

The original wp-content is placed in static/wp-content/uploads/YYYY/DD.

Search and replace

There are automated tools, which I did not test:

You’ll need to modify a lot of files manually. I’ve used this chance to drop a lot of old and outdated content from my blog.

Search and replace escaped characters

  • replace … with ...
  • replace „ with "
  • replace “ with "
  • replace   with
  • replace   with
  • replace &lt; with <
  • replace &gt; with >

Search and replace code markups

Wordpress supports code blocks. These should be searched for and be replaced with a suitable markdown replacement.

  • replace <blockquote class="wp-block-quote"> with markdown block
  • replace <blockquote class="twitter-tweet" with tweet shortcode

Search images

Uploaded files are usually stored in wordpress/wp-content/uploads folder. Images are often scaled down for several screen sizes or layout reasons in your blog post. My imported wp-content folder looks like this:

hugo-blog/static/wp-content/uploads/2021/02
├── AppleMusicLibrarySelection-261x300.png
├── AppleMusicLibrarySelection-290x290.png
├── AppleMusicLibrarySelection-744x510.png
├── AppleMusicLibrarySelection.png
├── MusicUpdatingLibrary-290x239.png
├── MusicUpdatingLibrary-300x159.png
└── MusicUpdatingLibrary.png

So I’ll delete every version starting with - after the filename or .thumbnail and moved them manually (because of the few occurences) from static to page-bundles, which is right next to the blog posts. This enables stuff like image processing.

The references to the moved images need then an update in the blog post md file. This is now depending on the way how you’ve originally added the image to the blog post and won’t be part of this post.

Additionally, there were a few images I had to check manually because of cryptic filenames. Those were probably used in blog posts, which I’ve already deleted. Wordpress doesn’t automatically cleanup the linked media. However, these files might also come from the wordpress conversion. They look like duplicates, which I’ve decided to remove by using a tool called jdupes. Install it with brew install jdupes and execute it with jdupes -r -d -N -X onlyext:png,jpg,gif . inside the hugo root. It will show you a list of duplicates that should help with identifying duplicate files.

-r is recursive -d is delete - asks for each entry it found -N is no prompt when used with -d and keeps the first found occurence -X onlyext:png,jpg,gif is to filter only for images with these endings

   [+] ./static/wp-content/uploads/2013/05/92b42fc0dd77937dab3f1fc69c11612c.jpg
   [-] ./static/wp-content/uploads/2013/05/fc635790673962f16d9e10363c4e5ad8.jpg
   [-] ./static/wp-content/uploads/2013/06/92b42fc0dd77937dab3f1fc69c11612c.jpg
   [-] ./static/wp-content/uploads/2013/06/fc635790673962f16d9e10363c4e5ad8.jpg
   [-] ./static/wp-content/uploads/2013/07/92b42fc0dd77937dab3f1fc69c11612c.jpg
   [-] ./static/wp-content/uploads/2013/07/b4f7e989575cb39b56455cef9a63aec4.jpg
   [-] ./static/wp-content/uploads/2013/07/fc635790673962f16d9e10363c4e5ad8.jpg
   [-] ./static/wp-content/uploads/2013/08/92b42fc0dd77937dab3f1fc69c11612c.jpg
   [-] ./static/wp-content/uploads/2013/08/fc635790673962f16d9e10363c4e5ad8.jpg
   [-] ./static/wp-content/uploads/2013/09/92b42fc0dd77937dab3f1fc69c11612c.jpg
   [-] ./static/wp-content/uploads/2013/09/fc635790673962f16d9e10363c4e5ad8.jpg
   [-] ./static/wp-content/uploads/2013/10/92b42fc0dd77937dab3f1fc69c11612c.jpg
   [-] ./static/wp-content/uploads/2013/10/fc635790673962f16d9e10363c4e5ad8.jpg
   [-] ./static/wp-content/uploads/2013/11/92b42fc0dd77937dab3f1fc69c11612c.jpg
   [-] ./static/wp-content/uploads/2013/11/fc635790673962f16d9e10363c4e5ad8.jpg


   [+] ./static/wp-content/uploads/2013/03/f6b58f2ba979ce0e3e176083c9fc3782.gif
   [-] ./static/wp-content/uploads/2013/04/f6b58f2ba979ce0e3e176083c9fc3782.gif


   [+] ./static/wp-content/uploads/2013/03/5027a0330756c412c0b0116e0cdbc939.jpg
   [-] ./static/wp-content/uploads/2013/04/5027a0330756c412c0b0116e0cdbc939.jpg

After this there were still a lot of cryptic looking files. Many of them still look like a duplicate according to their filename, but not to their file size:

-rw-r--r--   1 rudelm  staff   25486  3 Jan 00:33 022010c8d0cf8bd34ad58b051628d1d9.jpg
-rw-r--r--   1 rudelm  staff   25486  3 Jan 00:33 0703c65ee7cdab74b94f665b78366d14.jpg
-rw-r--r--   1 rudelm  staff   25486  3 Jan 00:33 1963042489e86ef304437d3345e628da.jpg

vs

-rw-r--r--   1 rudelm  staff   25109  3 Jan 00:33 022010c8d0cf8bd34ad58b051628d1d9.jpg
-rw-r--r--   1 rudelm  staff   25109  3 Jan 00:33 0703c65ee7cdab74b94f665b78366d14.jpg
-rw-r--r--   1 rudelm  staff   25109  3 Jan 00:33 1963042489e86ef304437d3345e628da.jpg

I’ve removed those files manually as I did not find a good working way to detect those duplicates just based on their filenames. I would have expected something like this from jdupes when its started with -Q which disables a lot of checks but without a chance.

Replace images

If all images are moved to next to the blog post as part of a page resource, it can be now referenced in the markdown by using a shortcode. Here’s my img.html since the linked had a small bug and did not show the figure caption:

{{ $img := $.Page.Resources.GetMatch (.Get 0)}}
<figure>
	<img src="{{ $img.RelPermalink }}" alt="{{(.Get 1)}}" />
	<figcaption>{{(.Get 1)}}</figcaption>
</figure>

Remove empty folders

The Jekyll import contained a lot of empty folders in static/wp-content/uploads which I’ve cleaned by using find ./static -type d -empty -delete

Remove unused folders

I’ve got some folders which where created by a plugin. They can all be deleted, e.g. static/wp-content/backupwp-* or static/wp-content/thumb-cache.

Setup defaults

The start of every markdown blog post contains meta inforamtion describing a blog post. If you’ll use the hugo new command, it will be pretty empty. That’s because there’s no default archetype configured. Add this to archetypes/default.md:

---
author: Your Author Name
title: "{{ replace .Name "-" " " | title }}"
date: {{ .Date }}
draft: true
---
# Introduction

Add URLs to front matter

The imported blog posts contained a line like this:

url: /2021/11/30/homebridge-apple-homekit-on-raspberry-pi/

This caused the resulting generated output to create a folder structure /2021/11/30/homebridge-apple-homekit-on-raspberry-pi/ with an index.html file. Without this change, this blog posts are moved automatically to /posts/2021/11/30/homebridge-apple-homekit-on-rapsberry-pi. This behaviour is explained here.

This breaks the existing blog URLs, so I’ll need to keep the url explicetely (or I need to accept that links are broken and search results are wrong). however, adding this to all posts is also very cumbersome.

By adding this to your config.yaml all blog posts will use the date information in a posts front matter. So I’ll be using this:

disablePathToLower: false
permalinks:
  post: "/:year/:month/:day/:title/"

The disablePathToLower: false is especially important, as it makes all URLs case insensitive and lower case only.

You can now remove all the url: entries from your files, except you want to manually specify a different URL for a post (e.g. a shorter version of the title).

Creating a new post

Use hugo new posts/hello.md to create a new blog post. It won’t have any additional timestamps in the filename unless you specify it, e.g. like hugo new posts/2021/12/30/hello/index.md. This can be simplified with something like this. Guess I’ll be blogging about this once I’ve got a good solution. I image something simple on the shell without the need for NodeJS or NPM.

Conclusion

Was it worth to put so much effort into Hugo? I would say yes. Its way more faster and gave me the chance to cleanup a lot of the old stuff. I’ll be doing refinements over the next few months and will probably update this post from time to time.

Last updated on Jan 06, 2022 22:29 CET
Built with Hugo
Theme Stack designed by Jimmy