0.0
The project is in a healthy, maintained state
Displays a badge on a Jekyll page for the package showing its version
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies
 Project Readme

Badge Gem Version

Displays a badge on a Jekyll page for the package showing its version.

Installation

Add the following to your Jekyll website's Gemfile:

group :jekyll_plugins do
  gem 'jekyll_badge'
end

And then execute:

$ bundle

Image

Copy the contents of demo/blog/images/git/ to a similarly named directory on your website.

Usage

See demo/index.html for examples.

Options

  • align – Float badge left, center or right.
  • class – Override default class for generated badge (rounded shadow).
  • clear – Ensure the badge is moved below (cleared) below floating elements that precede it.
  • git_url_base – Override the default value specified in

Development

After checking out this git repository, install dependencies by typing:

$ bin/setup

You should do the above before running Visual Studio Code.

Run the Tests

$ bundle exec rake test

Interactive Session

The following will allow you to experiment:

$ bin/console

Local Installation

To install this gem onto your local machine, type:

$ bundle exec rake install

To Release A New Version

To create a git tag for the new version, push git commits and tags, and push the new version of the gem to https://rubygems.org, type:

$ bundle exec rake release

Contributing

Bug reports and pull requests are welcome at https://github.com/mslinn/jekyll_badge.

License

The gem is available as open source under the terms of the MIT License.