jekyll_quote

Provides a Jekyll filter that creates formatted quotes.


Keywords
jekyll, jekyll-tag
License
MIT
Install
gem install jekyll_quote -v 0.4.0

Documentation

jekyll_quote Gem Version

jekyll_quote is a Jekyll plugin that displays formatted quotes.

See demo/index.html for examples.

Installation

Add the following line to your Jekyll project's Gemfile, within the jekyll_plugins group:

group :jekyll_plugins do
  gem 'jekyll_quote'
end

And then execute:

$ bundle install

Attribution

See jekyll_plugin_support for attribution

Additional Information

More information is available on Mike Slinn’s website.

Development

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

You can also run bin/console for an interactive prompt that will allow you to experiment.

To build and install this gem onto your local machine, run:

$ bundle exec rake install
jekyll_quote 0.1.0 built to pkg/jekyll_quote-0.1.0.gem.
jekyll_quote (0.1.0) installed.

Examine the newly built gem:

$ gem info jekyll_quote

*** LOCAL GEMS ***

jekyll_quote (0.1.0)
    Author: Mike Slinn
    Homepage:
    https://github.com/mslinn/jekyll_quote
    License: MIT
    Installed at: /home/mslinn/.gems

    Generates Jekyll logger with colored output.

Demo

Examine the output by running:

$ demo/_bin/debug -r

... and pointing your web browser to http://localhost:4444/

Unit Tests

Either run rspec from Visual Studio Code's Run and Debug environment (Ctrl-shift-D) and view the Debug Console output, or run it from the command line:

$ rspec

Build and Push to RubyGems

To release a new version,

  1. Update the version number in version.rb.
  2. Commit all changes to git; if you don't the next step might fail with an unexplainable error message.
  3. Run the following:
    $ bundle exec rake release
    The above creates a git tag for the version, commits the created tag, and pushes the new .gem file to RubyGems.org.

Contributing

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

License

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