getgrav / grav-plugin-breadcrumbs

Grav Breadcrumbs Plugin

Grav Breadcrumbs Plugin

Breadcrumbs is a Grav plugin that adds links to the previous pages (following the hierarchical structure). It is particularly useful if you are using Grav to run a blog.

Installation

Installing the Breadcrumbs plugin can be done in one of two ways. Our GPM (Grav Package Manager) installation method enables you to quickly and easily install the plugin with a simple terminal command, while the manual method enables you to do so via a zip file.

GPM Installation (Preferred)

The simplest way to install this plugin is via the Grav Package Manager (GPM) through your system's Terminal (also called the command line). From the root of your Grav install type:

bin/gpm install breadcrumbs

This will install the Breadcrumbs plugin into your /user/plugins directory within Grav. Its files can be found under /your/site/grav/user/plugins/breadcrumbs.

Manual Installation

To install this plugin, just download the zip version of this repository and unzip it under /your/site/grav/user/plugins. Then, rename the folder to breadcrumbs. You can find these files either on GitHub or via GetGrav.org.

You should now have all the plugin files under

/your/site/grav/user/plugins/breadcrumbs

NOTE: This plugin is a modular component for Grav which requires Grav, the Error and Problems plugins, and a theme to be installed in order to operate.

Usage

The breadcrumbs plugin doesn't require any configuration. The moment you install it, it is ready to use.

Something you might want to do is to override the look and feel of the breadcrumbs, and with Grav it is super easy.

Copy the template file breadcrumbs.html.twig into the templates folder of your custom theme, and that is it.

/your/site/grav/user/themes/custom-theme/templates/partials/breadcrumbs.html.twig

You can now edit the override and tweak it however you prefer.

Per-page Settings

The following options are available for use in a page's YAML frontmatter, placed within the breadcrumbs mapping:

Option	Default	Values	Description
max_depth	true	true or false	Determines whether breadcrumbs for pages beneath the current page will be generated.

Example Per-page Settings

---
title: Some page you wrote
breadcrumbs:
  may_descend: false # Breadcrumbs will not be generated for pages underneath this one.
---

Updating

As development for the Breadcrumbs plugin continues, new versions may become available that add additional features and functionality, improve compatibility with newer Grav releases, and generally provide a better user experience. Updating Breadcrumbs is easy, and can be done through Grav's GPM system, as well as manually.

GPM Update (Preferred)

The simplest way to update this plugin is via the Grav Package Manager (GPM). You can do this with this by navigating to the root directory of your Grav install using your system's Terminal (also called command line) and typing the following:

bin/gpm update breadcrumbs

This command will check your Grav install to see if your Breadcrumbs plugin is due for an update. If a newer release is found, you will be asked whether or not you wish to update. To continue, type y and hit enter. The plugin will automatically update and clear Grav's cache.

Manual Update

Manually updating Breadcrumbs is pretty simple. Here is what you will need to do to get this done:

• Delete the your/site/user/plugins/breadcrumbs directory.
• Download the new version of the Breadcrumbs plugin from either GitHub or GetGrav.org.
• Unzip the zip file in your/site/user/plugins and rename the resulting folder to breadcrumbs.
• Clear the Grav cache. The simplest way to do this is by going to the root Grav directory in terminal and typing bin/grav clear-cache.

Note: Any changes you have made to any of the files listed under this directory will also be removed and replaced by the new set. Any files located elsewhere (for example a YAML settings file placed in user/config/plugins) will remain intact.

Configuration

Simply copy the user/plugins/breadcrumbs/breadcrumbs.yaml into user/config/plugins/breadcrumbs.yaml and make your modifications.

enabled: true
show_all: true
built_in_css: true
include_home: true
include_current: true
icon_home: ''
icon_divider_classes: 'fa fa-angle-right'
link_trailing: false

Options are pretty self explanatory.

grav-plugin-breadcrumbs's Issues

Schema.org migration

Current schema for breadcumps is deprecated by Google

data-vocabulary.org schema is deprecated and is no longer supported by Google. Please migrate to using schema.org types.

and will be ignored after April 2020. Consider movement to Schema.org

Breadcrumbs can't be added as a modular?

Making a breadcrumbs modular with:

{% if config.plugins.breadcrumbs.enabled %}
    {% include 'partials/breadcrumbs.html.twig' %}
{% endif %}

in it doesn't work. Only fa-home icon appears. Is it intentional? Is there any way I could put working breadcrumbs between modulars which are loaded through:

{% for module in page.collection() %}
    {{ module.content }}
{% endfor %}

?

no breadcrumbs for search, archives, etc?

Maybe I am missing something as I am new to grav, but can't figure this one out. Breadcrumbs are working on all blog related pages, but pages like :

https://blog.example.com/search/query:hills

This one outputs the html with no pages included : 

<ol class="blog-breadcrumb" itemscope="" itemtype="http://schema.org/BreadcrumbList">
    </ol>

https://blog.example.com/archives_month:jul_2014
https://blog.example.com/tag:photography

These two only show the root level breadcrumb : 

<ol class="blog-breadcrumb" itemscope="" itemtype="http://schema.org/BreadcrumbList">
        	<li itemprop="itemListElement" itemscope="" itemtype="http://schema.org/ListItem">
            				<a itemprop="item" href="/"><span itemprop="name">Blog</span></a>	
                    	<meta itemprop="position" content="1"> 
        </li>
    </ol>

Does it not work for these types or what is going on? The pages I mentioned use their respective plugins from the grav team. I am using the blog skeleton as my default.

Large padding between entries

Is there a way to make the padding between the breadcrum entries smaller? I am using the quark theme:

non-routable pages are included in breadcrumbs

I have a simple site only using pages and I have a hierarchy that nests some folders with markdown files with organizational folders without markdown files. Currently, the plugin adds these non-routable folders in the breadcrumbs list.

The simple fix, which seems to be working for me, is to check routability before adding to the hierarchy array in classes/breadcrumbs.php:

while($current && !$current->root()) {
     if($current->routable()) {
         $hierarchy[$current->url()] = $current;
     }
     $current = $current->parent();
 }

EDIT: Sorry for not making a PR. Being a bit lazy while working on the site. ;)

Is not responsive?

It doesn't seem like this is mobile friendly. Long blog names distort the layout. As an interim fix, I made a small change to the else portion of the twig to keep everything on one line and within a mobile display.

<span itemprop="name">{{ crumb.menu|truncate(15) }}</span>

This is just a bandaid, I hope someone can help with some CSS guidance.

Thanks,
J

Has This Plugin Been Abandoned?

Given that Google dropped support on April 6th for the markup used by this plugin, and that despite a fix posted here on Jan 22, should I assume this plugin is no longer supported?

FeatureRequest : Custom Breadcrumb Title

Hello I am Yoast Wordpress user can you please add breadcrumb title in admin please as I always use custom breadcrumb title for the page like my page name is Free Online Tutorials and Courses so I don't want this name in every page I want custom name like Tutorials only hope you understand, It will be great if you will consider adding it.

Removing the plugin causes website crash

Removing the plugin causes website frontend crashes with error

RuntimeException (400) Template "partials/breadcrumbs.html.twig" is not defined in "blog.html.twig" at line 27.

After deleting the plugin config file left in user/config/plugins, site works again.

Link trailing

As a non native speaker, can someone please explain the purpose of the setting "link trailing"?
Google was not as helpful as I hoped it would be.

Thanks in advance.

Add option to ignore current page

I think it would be nice if there could be an option to include/exclude the current page on the breadcrumb trail, similar to how you can optionally include home.

(I'll open a PR for this soon)

broken link (404)

grav-plugin-breadcrumbs/templates/partials/breadcrumbs.html.twig

Line 6 in cef8c06

<div id="breadcrumbs" itemscope itemtype="http://data-vocabulary.org/Breadcrumb">

i think the new link: https://schema.org/breadcrumb

How to set "Home" link with custom text?

For not it takes the name from homepage title set in .md file. Is it possible to set it independent of homepage title?

For example, homepage title is "News around the world", and i want to make it just "Home".

Schema Link

Just to save this for reference: https://schema.org/BreadcrumbList

Composer.json name : Does not match the regex pattern

[...@... breadcrumbs]$ composer update


  [Composer\Json\JsonValidationException]
  "./composer.json" does not match the expected JSON schema:
   - name : Does not match the regex pattern ^[a-z0-9]([_.-]?[a-z0-9]+)*/[a-z0-9](([_.]?|-{0,2})[a-z0-9]+)*$

Works after changing name to getgrav/grav-plugin-breadcrumbs

Composer 2.1.14
PHP 7.4.25

Breadcrumbs doesn't recognize Flex Object path component

When I display a single Flex Object from a directory, the URL looks something like /about/careers/id:11025b4c30e0e7c93e8ab97dfd3611c7 but the bread crumbs display as About > Careers, ignoring the object component (e.g., About > Careers > My Object Title). This is using a Gantry-based theme but I don't think that's a factor.

Cannot get the breadcrumb plugin to work

Hello,

I've followed the instructions, but the breadcrumb plugin isn't working. I'm running Grav 0.9.2.

Any help would be really appreciated.

Thanks,
Jeff

Google Ends Rich Results for Data-Vocabulary.org Structured Data - transition to Schema.org

Hi,
many of you probably received an infotmation from google search console about error regarding Data-Vocabulary.org is being deprecated. here is the quick fix (it is really quick, spent 20min with it, not tested widely) to this to switch from Data-Vocabulary.org to the Shema.org which is supportted by Google now. It consists of 2 modifications:
1. breadcrumbs/templates/partials/breadcrumbs.html.twig

{% set crumbs = breadcrumbs.get() %}
{% set breadcrumbs_config = config.plugins.breadcrumbs %}
{% set divider = breadcrumbs_config.icon_divider_classes %}
{% set lang = "/"~html_lang %}
{% set siteurl = base_url_absolute|replace({ (lang) : ""}) %}

{% if crumbs|length > 1 or breadcrumbs_config.show_all %}
<ol id="breadcrumbs" itemscope itemtype="https://schema.org/Breadcrumblist">
    {% if breadcrumbs_config.icon_home %}
    <i class="{{ breadcrumbs_config.icon_home }}"></i>
    {% endif %}
	{% set position = 1 %}
    {% for crumb in crumbs %}
        {% if not loop.last %}
            {% if crumb.routable %}
			<li itemprop="itemListElement" itemscope itemtype="https://schema.org/ListItem">
                <a href="{{ siteurl }}{{ crumb.url }}" itemprop="item"><span itemprop="name">{{ crumb.menu }}</span></a>
				<meta itemprop="position" content="{{ position }}">
			</li>
            {% else  %}
			<li itemprop="itemListElement" itemscope itemtype="https://schema.org/ListItem">
                <span itemprop="name">{{ crumb.menu }}</span>
				<meta itemprop="position" content="{{ position }}">
			</li>
            {% endif %}
            <i class="{{ divider }}"></i>
        {% else %}
            {% if breadcrumbs_config.link_trailing %}
			<li itemprop="itemListElement" itemscope itemtype="https://schema.org/ListItem">
                <a href="{{ siteurl }}{{ crumb.url }}" itemprop="item"><span itemprop="name">{{ crumb.menu }}</span></a>
				<meta itemprop="position" content="{{ position }}">
			</li>
            {% else %}
			<li itemprop="itemListElement" itemscope itemtype="https://schema.org/ListItem">
                <span itemprop="name">{{ crumb.menu }}</span>
				<meta itemprop="position" content="{{ position }}">
			</li>
            {% endif %}
        {% endif %}
		{% set position = position + 1 %}
    {% endfor %}
</ol>
{% endif %}

2. breadcrumbs/css/breadcrumbs.css

#breadcrumbs {
    height: 3rem;
    line-height: 3rem;
    padding-left: 3rem;
}
#breadcrumbs li {
    display: inline-block;
    padding: 0 1rem;
}
#breadcrumbs ol {
    padding-left: 0;list-style:none;display:-webkit-inline-box;
}

#breadcrumbs i {
    display: inline-block;
    width: 20px;
    text-align: center;
} 

this will mage Google happy and you site will look exactly the same. You may test the structured data result here https://search.google.com/structured-data/testing-tool

Including category into the breadcrumb trail

Thank you for this plugin.

Is there a plan to include also categories into the trail? Ex:
Home > Sports > Article 1

not displayed when the menu is minimized. tell me what could be the reason

not displayed when the menu is collapsed. tell me what could be the reason. clean GRAV with theme antimatter