Breadcrumbs In Hugo

Breadcrumbs In Hugo was first published on Farai's Codelab.

---

Breadcrumbs are a type of navigation which shows pages in a particular order, like viewing history or, in my case, a page’s hierarchy.

Implementing this was frustrating, but I eventually figured it out. In short, you need to do something similar to this:

<!-- In whatever template -->
<p class="breadcrumbs">
    {{ partial "breadcrumbs.html" . }}
</p>

Then in breadcrumbs.html, include this:

{{ with .Parent }}
    {{ partial "breadcrumbs.html" . }}
    {{ if .Parent }}→{{ end }}
    <a href="{{ .Permalink }}">{{ .Title }}</a>
{{ end }}

The important thing is that you:

1. invoke the recursion by calling the breadcrumbs partial to the .Parent.
2. provide the separator (given you have one) conditional to whether the current .Parent has a parent and
3. link to the current crumb.

That’s it.

You can play with semantics based on what you need. Want to use nav > ul instead of p and make them list items so you can use Bootstrap’s breadcrumbs? Go ahead.

I spent far more time than I should have trying to solve this and this is what I ended up with. If you want the full story on how I got to this point, it’s a Patreon Exclusive. Thanks to nfriedli for figuring this out!!

---

Thanks for reading! If you liked this post, consider supporting my work by:

• sharing my work,
• refering me for a job (or hire me for freelance work),
• sponsoring me on Patreon,
• buying Me A Coffee,
• buying Me A Ko-Fi,
• sending me a tip on Paypal,
• buy something on Amazon with my affiliate link (I’ll earn a commision on this as an Amazon affiliate),
• or buy a domain on Namecheap with my affiliate link.

You can also subscribe to my newsletter.

Have feedback? Send an email to gandiyafarai+feedback at gmail dot com

Comments

[Mark Stouffer]

I spent way too much time trying to concatinate a string in Hugo yesterday to build the path before I found this recursive fix, which works perfectly. Thanks.