Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/paulrobertlloyd/jekyll-roman

A liquid filter for Jekyll that converts numbers into Roman numerals
https://github.com/paulrobertlloyd/jekyll-roman

jekyll-plugin

Last synced: about 1 month ago
JSON representation

A liquid filter for Jekyll that converts numbers into Roman numerals

Awesome Lists containing this project

README

        

# jekyll-roman

A liquid filter for Jekyll that converts numbers into Roman numerals.

[![Gem version](https://img.shields.io/gem/v/jekyll-roman.svg)](https://rubygems.org/gems/jekyll-roman)
[![Build status](https://github.com/paulrobertlloyd/jekyll-roman/workflows/test/badge.svg)](https://github.com/paulrobertlloyd/jekyll-roman/actions)

## Installation

1. Add `gem 'jekyll-roman'` to your site’s Gemfile and run `bundle`
2. Add the following to your site’s `_config.yml`:

```yaml
gems:
- jekyll-roman
```

## Usage

This filter takes any given whole number and converts it. Any other types of string are ignored. For example, if you wish to display the year in your site’s copyright statement as roman numerals, you would write the following:

```html

© {{ site.time | date:"%Y" | roman }}


````

## Testing

1. `bundle install`
2. `bundle exec rake spec`

## Contributing

1. Fork the project
2. Create a descriptively named feature branch
3. Add your feature
4. Submit a pull request

## Acknowledgements

Code based on that found in [this discussion on Stack Overflow](http://stackoverflow.com/questions/26092510/roman-numerals-in-ruby). If you know of a better way of achieving the same result, please let me know!