Typogruby

Typogruby can apply a set of text filters to your HTML documents to make your text look better. It is based on Django’s typogrify.

Quick demonstration

"Typogruby makes HTML look smarter & better, don't you think?"

is turned into:

<span class="dquo">&ldquo;</span>Typogruby makes
<span class="caps">HTML</span> look smarter
<span class="amp">&amp;</span> better,
don&rsquo;t you&nbsp;think?&rdquo;

Compare the difference, given some appropriate styling:

Quick start guide

Installation

Typogruby is a Ruby gem and as such requires Ruby installed on your system. Mac OS X and *nix systems usually come with Ruby installed by default.

To install the gem, open a terminal window and run:

gem install typogruby

Usage

You can now use typogruby in two ways. Either apply it to a file in the terminal:

typogruby index.html

Type typogruby -h for more information. Second, you can use it from a Ruby script:

require 'typogruby'
puts Typogruby.improve('Hello, world!')

Included filters

• Rubypants is used for nice special characters, such as quotes and dashes
• A port of Shaun Inman’s widon’t is used to prevent widows (using an   to prevent a single word on a new line).
• All consecutive capital letters are wrapped in span.caps
• All quotes at the start of a line are wrapped in span.dquo
• All ampersands (&) are wrapped in span.amp
• Replace special characters with HTML entities (lifted from TextMate HTML bundle)

Credits

• Author: Arjan van der Gaag (arjan@arjanvandergaag.nl)
• License: MIT License (same as Ruby)

More information

You can read more usage instructions in the API documentation. Also check out the license and changelog. You can report any bugs in the Github issue tracker.