Breadcrumbs

By Sheriff Docs ~ 6 min read

Sheriff automatically generates breadcrumbs for your pages.

You don't need to write it yourself.

Whenever Sheriff builds a page, the Scout module scans your paths and directory tree and builds breadcrumbs for that page automatically.

Note

You'll remember that Scout handles all site navigation menus, to include the table of contents and sidebars.

Important

Since Sheriff breadcrumbs display the navigation via the file directories, they are not clickable links, because the parent directories are not pages. Since the current page is already displayed (you are looking at it), that link is also not clickable.

The Big Picture

The process is completely automatic.

Markdown
    │
    ▼
Scout scans file tree
    │
    ▼
Breadcrumbs generated

Markdown
    │
    ▼
Scout scans file tree
    │
    ▼
Breadcrumbs generated

If your theme includes a breadcrumbs slot, Sheriff will automatically inject the finished breadcrumbs into the page. The Outpost and Siegemate themes have breadcrumbs in the top right panel.

Breadcrumbs, circled in red