Awesome
jekyll_quote
![Gem Version](https://badge.fury.io/rb/jekyll_quote.svg)
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
-
Install the
jekyll_quote
Ruby gem and mark it as a dependency of your project by typing:$ bundle
-
Copy the CSS classes from
demo/assets/css/jekyll_quote.css
to your Jekyll project's CSS file.
Syntax
{% quote OPTIONS %}
Content of quote goes here.
{% endquote %}
The default preposition is 'From'.
OPTIONS are:
break
– Put the citation on a separate line. Ignored ifcite
was not specified.by
– Preface the citation with the preposition 'By'. Ignored ifcite
was not specified.cite
– Citation textclass
– Apply additional CSS classesnoprep
– Do not preface the citation with a preposition. Ignored ifcite
was not specified.style
– Apply additional CSS stylingurl
– URL for the citation. Ignored ifcite
was not specified.
Usage Example
{% quote cite="Blaise Pascal, in Lettres provinciales"
url="https://en.wikipedia.org/wiki/Lettres_provinciales"
%}
I have only made this letter longer because
I have not had the time to make it shorter.
{% endquote %}
Attribution
See jekyll_plugin_support
for attribution
Demo
A demo / test website is provided in the demo
directory.
It can be used to debug the plugin or to run freely.
Please examine the HTML files in the demo to see how the plugin works.
To run the demo freely from the command line, type:
$ demo/_bin/debug -r
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.
Running the 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
(<kbd>Ctrl</kbd>-<kbd>shift</kbd>-<kbd>D</kbd>) and view the Debug Console output,
or run it from the command line:
$ rspec
Build and Push to RubyGems
To release a new version,
-
Update the version number in
version.rb
. -
Commit all changes to git; if you don't the next step might fail with an unexplainable error message.
-
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
- Fork the project
- Create a descriptively named feature branch
- Add your feature
- Submit a pull request
License
The gem is available as open source under the terms of the MIT License.