https://github.com/kawakamimoeki/jekyll-breadcrumb-tag

Jekyll x Breadcrumbs
https://github.com/kawakamimoeki/jekyll-breadcrumb-tag

breadcrumbs jekyll ruby

Last synced: 3 months ago
JSON representation

Jekyll x Breadcrumbs

• Host: GitHub
• URL: https://github.com/kawakamimoeki/jekyll-breadcrumb-tag
• Owner: kawakamimoeki
• Created: 2022-10-28T08:44:47.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-10-29T12:10:24.000Z (over 2 years ago)
• Last Synced: 2023-10-04T08:54:32.608Z (over 1 year ago)
• Topics: breadcrumbs, jekyll, ruby
• Language: Ruby
• Homepage:
• Size: 7.81 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Jekyll Breadcrumbs Tag

Breadcrumbs tag for Jekyll.

## Installation

Add this line to your application's Gemfile:

```ruby

group :jekyll_plugins do

  gem "jekyll-breadcrumbs-tag"

end

```

```

bundle

```

```yml

# _config.yml

plugins: [jekyll-breadcrumbs-tag]

```

## Usage

`_config.yaml`:

```yaml

breadcrumbs:

  -

    name: top

    link: /

    text: Top Page

  -

    name: about

    link: /about

    text: About Page

    parent: top

```

```html

<%= breadcrumbs about %>

```

Custom template `_includes/breadcrumbs.html`:

```html

{% for breadcrumb in breadcrumbs %}

  {% if forloop.first == false %} > {% endif %}{{ breadcrumb.text }}

{% endfor %}

```

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).