Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mslinn/jekyll_badge
Displays a badge on a Jekyll page for the package showing its version
https://github.com/mslinn/jekyll_badge
Last synced: 3 months ago
JSON representation
Displays a badge on a Jekyll page for the package showing its version
- Host: GitHub
- URL: https://github.com/mslinn/jekyll_badge
- Owner: mslinn
- License: mit
- Created: 2023-11-12T15:48:15.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2024-07-26T11:16:41.000Z (5 months ago)
- Last Synced: 2024-09-26T08:29:24.661Z (3 months ago)
- Language: Ruby
- Homepage:
- Size: 504 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# `Badge` [](https://jekyll_badge.fury.io/rb/jekyll_badge)
Displays a badge on a Jekyll page for the package showing its version.
## Installation
Add the following to your Jekyll website's `Gemfile`:
```ruby
group :jekyll_plugins do
gem 'jekyll_badge'
end
```
And then execute:
```shell
$ bundle
```
### Image
Copy the contents of `demo/blog/images/git/` to a similarly named directory on your website.
## Usage
See [demo/index.html](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:
```shell
$ bin/setup
```
You should do the above before running Visual Studio Code.
### Run the Tests
```shell
$ bundle exec rake test
```
### Interactive Session
The following will allow you to experiment:
```shell
$ bin/console
```
### Local Installation
To install this gem onto your local machine, type:
```shell
$ 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:
```shell
$ 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](https://opensource.org/licenses/MIT).