Skip to content

Commit fc5d898

Browse files
author
Lutz
committed
Better configuration description and fixing some glitches
1 parent 93a5c1b commit fc5d898

File tree

1 file changed

+18
-3
lines changed

1 file changed

+18
-3
lines changed

README.md

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,14 +36,14 @@ Smart and fast breadcrumbs for posts, pages and collections with SEO support, op
3636
{% include nav-breadcrumbs.html %}
3737
```
3838

39-
2. Integrate your icon as SVG into icon.svg or an image in icon.html. If you do not want an icon as home breadcrumb change the line in nav-breadcrumbs.html
39+
2. As default the root breadcrumb is visible as *Start*. If you want to integrate an image as root breadcrumb, e.g. as SVG, update the icon.svg with your SVG. If you want to integrate a other image type update icon.html. Also change the line of code in nav-breadcrumbs.html from
4040

4141
```
42-
{% include icon.html class="breadcrumb-item" %}
42+
<a class="breadcrumb-item" href={{ "/" | prepend: site.baseurl | prepend: site.url }}>Start</a>
4343
```
4444
to
4545
```
46-
<a class="breadcrumb-item" href="/">Home</a>
46+
{% include icon.html class="breadcrumb-item" %}
4747
```
4848

4949
3. Use YAML *title* or *breadcrumb* to define the title of breadcrumb items.
@@ -62,6 +62,21 @@ Smart and fast breadcrumbs for posts, pages and collections with SEO support, op
6262
```
6363
YAML *breadcrumb:* is optional and overrules YAML title, in case you want a different title in breadcrumb item as the page title.
6464

65+
4. If you use the [jekyll-language-plugin](https://github.com/vwochnik/jekyll-language-plugin) change the line of code in nav-breadcrumbs.html from
66+
67+
```
68+
{% assign caption = crumb.title %}
69+
```
70+
to
71+
```
72+
{% assign subset = crumb.subset %}
73+
{% if subset %}
74+
{% capture caption %}{% tif subset %}{% endcapture %}
75+
{% else %}
76+
{% assign caption = crumb.title %}
77+
{% endif %}
78+
```
79+
to get breadcrumb items translated.
6580

6681
## Note
6782
* If you use [jekyll-language-plugin](https://github.com/vwochnik/jekyll-language-plugin) jekyll-breadcrumbs will translate each breadcrumb item if YAML *subset* in the page is set. If so this plugin will seek at first for *breadcrumb* within the subset of the language file, if breadcrumb is not found in the langauge file it will look for title within the subset.

0 commit comments

Comments
 (0)