Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/scampersand/jekyll-pants
Jekyll plugin for typographic punctuation
https://github.com/scampersand/jekyll-pants
jekyll jekyll-plugin smart-quotes smartypants
Last synced: about 1 month ago
JSON representation
Jekyll plugin for typographic punctuation
- Host: GitHub
- URL: https://github.com/scampersand/jekyll-pants
- Owner: scampersand
- License: mit
- Created: 2016-07-17T20:32:37.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2016-10-17T21:03:11.000Z (over 8 years ago)
- Last Synced: 2024-10-19T19:47:43.675Z (3 months ago)
- Topics: jekyll, jekyll-plugin, smart-quotes, smartypants
- Language: Ruby
- Homepage:
- Size: 28.3 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# jekyll-pants
[](https://rubygems.org/gems/jekyll-pants)
[](https://travis-ci.org/agriffis/jekyll-pants)
[](https://codecov.io/gh/scampersand/jekyll-pants)
Jekyll-Pants is a [Jekyll](http://jekyllrb.com/) plugin to convert plain ASCII
punctuation to typographic punctuation HTML entities. It relies on
[RubyPants](https://github.com/jmcnevin/rubypants) which is a Ruby port of the
smart-quotes library SmartyPants.
InputOutputRendered
Here's an example--as
you can see...
Here’s an example—as
you can see…
Here’s an example—as you can see…
## Rationale
This plugin exists because the default Jekyll support for smart quotes is limited to:
1. [Markdown](https://daringfireball.net/projects/markdown/) parsed by
[kramdown](http://kramdown.gettalong.org/) (see note below for how to
disable kramdown's quoting in favor of jekyll-pants).
2. The [smartify](https://jekyllrb.com/docs/templates/#filters) filter which is
actually another way to invoke kramdown's markdown processor, so it doesn't
work as desired on HTML.
Unlike the built-in solutions, jekyll-pants works on HTML, making it suitable
for applying typographic punctuation to an entire site of hand-authored HTML pages.
## Usage
Add `jekyll-pants` to your site's Gemfile in the `:jekyll-plugins` group and run
`bundle` to install and update Gemfile.lock:
```ruby
group :jekyll_plugins do
gem "jekyll-pants"
end
```
In your base layout, filter the content through the `pants` filter:
```liquid
...
{{content|pants}}
```
Since RubyPants parses HTML tags, this will apply typographic quoting, dashes
and ellipses to text content, but will ignore preformatted text in `
` and ``.
## Configuration
By default, this plugin invokes RubyPants with no options, so RubyPants runs in
its default mode which is "old-school." In old-school mode, double-dash
translates to an en-dash and triple-dash translates to an em-dash.
This can be modified in Jekyll's `_config.yml` under the `pants` key, for
example:
```yaml
pants:
options: [1, 'prevent_breaks']
```
For the available options, see https://github.com/jmcnevin/rubypants/blob/master/lib/rubypants/core.rb
## Compatibility with kramdown
Jekyll's default markdown processor
is [kramdown](http://kramdown.gettalong.org/), and by default kramdown applies
smart quoting and typographic substitutions. Its algorithm works a little
differently from RubyPants which means that you'll get mixed results with
content coming from both markdown and HTML sources.
Jekyll-Pants supplies a parser subclass as
[recommended by kramdown's author](https://github.com/gettalong/kramdown/pull/379).
The subclass is called `Pantsdown` and removes the `:smart_quotes` and
`:typographic_syms` span parsers from the list.
To use this subclass and thereby defer to RubyPants for
quotes, dashes and ellipses, put the following in your `_config.yml`:
```yaml
kramdown:
input: Pantsdown
```