https://github.com/mslinn/jekyll_highlight_tag

https://github.com/mslinn/jekyll_highlight_tag

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/mslinn/jekyll_highlight_tag
• Owner: mslinn
• License: mit
• Created: 2023-07-08T12:02:45.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2024-07-25T19:04:57.000Z (5 months ago)
• Last Synced: 2024-10-12T09:45:23.507Z (3 months ago)
• Language: Ruby
• Size: 471 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        
# `JekyllHighlight` [![Gem Version](https://badge.fury.io/rb/jekyll_highlight.svg)](https://badge.fury.io/rb/jekyll_highlight)

Demo Jekyll tag plugin that shows how to customize a generated Jekyll tag gem.

This plugin would be better implemented as a filter, not a tag.

The original generated output of the [nugem](https://www.mslinn.com/ruby/6700-thor.html) command is provided

as the `original` git branch of this project.

The `nugem` program is still in the early stages of development,

so the `nugem` output has been improved since this project was generated.

## Installation

Add the following to your Jekyll website’s `Gemfile`:

```ruby

group :jekyll_plugins do

  gem 'jekyll_highlight'

end

```

And then execute:

```shell

$ bundle

```

## Sample Usage

```html

{% highlight text="highlighted text" %}

{% highlight text="highlighted text" fg_color="red" %}

{% highlight text="highlighted text" fg_color="red" bg_color="grey" %}

```

## Development

After checking out the repo, run `bin/setup` to install dependencies.

Then, run `bundle exec rake test` 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, run `bundle exec rake release`,

which will create a git tag for the version, push git commits and tags,

and push the gem to https://rubygems.org.

## Contributing

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

## License

The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).