Switching to Hugo from MkDocs: My MacDown Tutorial Journey

As an open-source enthusiast, I'm no stranger to diving into new software without a manual. However, when I stumbled upon the Hugo theme I liked and decided to give it a try, I found myself needing to wrap my head around its getting started documentation. Fortunately, Kris from Aalto FabLab suggested I check out his YouTube tutorials on using Hugo, which proved to be a valuable resource.

I was determined not to work in straight HTML, as I had grown accustomed to working with Markdown through my experience with MkDocs. After exploring various former student websites, I decided that MkDocs wasn't the best fit for me and opted to try something new. This marked the beginning of my MacDown tutorial journey.

One of the key challenges I faced was figuring out how to enable spell check in MacDown or any other Markdown editor I might choose to use long-term. Luckily, I soon discovered Atom's built-in spell check feature, which has since become my go-to editor.

To ensure a smooth transition, I created a branch with my MkDocs setup as a backup plan in case the switch to Hugo didn't work out. This decision also allowed me to experiment with branching and explore its capabilities.

During this process, I also encountered submodules and removed outdated content, which is described further below. After skimming through Neil's suggested Git tutorial, I found it focused on commands that weren't essential for my project. My initial efforts are documented on my Week 0 Page, which was during the student bootcamp week.

As soon as I set up my GitLab account, I began experimenting with my site and brainstorming a final project idea. This marked the beginning of an exciting journey into the world of Hugo and MacDown, and I'm excited to see where it takes me.

Final Project Idea

My proposed project involves creating a website that showcases my experience with Hugo and MacDown, highlighting the challenges I faced and the solutions I discovered along the way. The site will feature tutorials, tips, and best practices for using these tools effectively, making it a valuable resource for fellow students and developers who may be embarking on similar journeys.

In conclusion, switching to Hugo from MkDocs was an exciting adventure that allowed me to explore new software and expand my skills as a developer. Through this process, I learned the importance of branching and backups, as well as the value of experimentation and learning from failure. As I continue to work on my project, I'm excited to see what other challenges and opportunities lie ahead.

Macdown tutorial figure