Breadcrumb Navigation

How to add breadcrumb navigation to your Doks website.

On this page

• Enable
• Example
  • HTML

Enable

Breadcrumb navigation support is switched off per default. Activate it by setting breadCrumb = true in ./config/_default/params.toml.

Example

HTML

<nav aria-label="breadcrumb">
  <ol class="breadcrumb">
    <li class="breadcrumb-item"><a href="https://getdoks.org/">Home</a></li>
    <li class="breadcrumb-item"><a href="https://getdoks.org/docs/">Docs</a></li>
    <li class="breadcrumb-item"><a href="https://getdoks.org/docs/prologue/">Prologue</a></li>
    <li class="breadcrumb-item active" aria-current="page">Introduction</li>
  </ol>
</nav>

Note, this is an optional user breadcrumb trail — next to the already implemented JSON-LD for rich results.