octopress-quote-tag

1.0.4last stable release 10 years ago
Complexity Score
Low
Open Issues
0
Dependent Projects
2
Weekly Downloadsglobal
44

License

  • MIT
    • Yesattribution
    • Permissivelinking
    • Permissivedistribution
    • Permissivemodification
    • Nopatent grant
    • Yesprivate use
    • Permissivesublicensing
    • Notrademark grant

Downloads

Readme

Octopress Quote Tag

Easy HTML5 blockquotes for Jekyll sites.

Installation

Using Bundler

Add this gem to your site’s Gemfile in the :jekyll_plugins group:

group :jekyll_plugins do
  gem 'octopress-quote-tag'
end

Then install the gem with Bundler

$ bundle

Manual Installation

$ gem install octopress-quote-tag

Then add the gem to your Jekyll configuration.

gems:
  -octopress-quote-tag

Usage

{% quote [options] %}
Some great quote
{% endquote %}

Options:

option default description author nil String: Quote author title nil String: Title of work cited url nil String: Link to work

Example

{% quote author:"Bob McAwesome" url:http://example.com title:"Great Wisdom" %} 
Never pet a burning dog.
{% endquote %}
<figure class='quote'>
  <blockquote>
    <p>Some great quote</p>
  </blockquote>
  <figcaption class='quote-source'>
    <span class='quote-author'>Bob McAwesome</span>
    <cite class='quote-title'><a href='http://example.com'>Great Wisdom</a></cite>
  </figcaption>
</figure>

Why?

In Markdown Blockquotes are simple but attribution isn’t. Also, writing the semantic HTML is tricky and easy to forget.

> Some cool quote

# becomes:

<blockquote>
  <p>Some cool quote</p>
</blockquote>

But what if you want to cite an author or a source?

> Some cool quote
> - Bob McAwesome

# becomes:

<blockquote>
  <p>Some cool quote
- Bob McAwesome</p>
</blockquote>

Which doesn’t work at all since a browser will see it as:

Some cool quote - Bob McAwesome

And now you know.

Contributing

  1. Fork it ( https://github.com/octopress/quote-tag/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request

Dependencies

CVE IssuesActive
0
Scorecards Score
No Data
Test Coverage
No Data
Follows Semver
Yes
Github Stars
17
Dependenciestotal
7
DependenciesOutdated
1
DependenciesDeprecated
0
Threat Modelling
No
Repo Audits
No

Learn how to distribute octopress-quote-tag in your own private RubyGems registry

gem install octopress-quote-tag
Processing...
Done

5 Releases

RubyGems on Cloudsmith

Getting started with RubyGems on Cloudsmith is fast and easy.