Docs

Breadcrumb

Use the breadcrumb shortcode to display the current page’s location within the site’s navigational hierarchy.
Overview   Default Breadcrumb   Breadcrumb for Specific Path   Frontmatter Configuration   Styling   Arguments  

Overview  

Use the breadcrumb shortcode to display the current page’s location within the site’s navigational hierarchy.

Default Breadcrumb  

The following shortcode displays a breadcrumb for the current page.

markdown 
{{< breadcrumb >}}

Set path to a specific path to adjust the breadcrumb.

markdown 
{{< breadcrumb path="kbd" >}}

Frontmatter Configuration  

Added in v0.14.1     

Hugo has the option to exclude certain pages from publishing  using the build options in the page’s frontmatter. These pages do not have a permalink, but are still part of the breadcrumb. You can set the optional parameter redirect to an alternative path if needed.

---
title: Docs
redirect: "/docs/"
build:
  list: false
  render: false
---

Styling  

Check the Bootstrap documentation  for additional styling options.

Arguments  

The shortcode supports the following arguments:

Name Type Required Default Comment
path path Path of the page that the element references.
Name Type Required Default
path path
Path of the page that the element references.
On this page