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: 4 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 (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-12-21T16:26:48.000Z (over 1 year ago)
- Last Synced: 2025-02-01T03:07:25.574Z (over 1 year 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
#### Keyword Options
- `clear` – Ensures the badge is rendered below preceding floating elements.
- `debug` – Display debugging information on the rendered page
#### Primary Options
Override these name/value options as required.
- `align` – Align badge `left`, `center` or `right`, defaults to `right`.
- `alt` – Alt text for badge image, also used as title for badge.
Defaults to `name`.
- `class` – Override classes for generated badge,
defaults to `rounded shadow`.
- `dist_url` – Badge banner link target (download page),
defaults to `https://rubygems.org/gems/name`.
- `image` – Git repository image, without the filetype,
defaults to `/blog/images/git/github-mark`.
- `name` – name of component, defaults to the name of the enclosing page.
- `label` – displayed name of the badge, defaults to `name`.
- `style` – Additional CSS style for the badge container.
- `title` – Displayed text when the user hovers their mouse over the
badge. Defaults to the `alt` value.
- `type` – Type of badge to display.
Choices are `ruby_gem` (default) and `golang`.
- `user_id` – GitHub user id
(only required for type `golang`, defaults to `mslinn`.)
#### Derived Options
Derived options can be overridden, just like primary options.
- `badge_svg` – URL for badge image,
defaults to `https://badge.fury.io/rb/name.svg`.
- `git_url_base` – GitHub User URL,
defaults to `https://github.com/mslinn`.
- `git_url` – Repository URL, defaults to `git_url_base/name`.
## 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).