meritt / richtypo.js

Typography enhancer for Node.js

Richtypo: typography enhancer for Node.js

The main purpose of this library is to enhance typography of your HTML. It supposes that your texts already have right quotes, dashes and other symbols (you can use Typography Keyboard Layout). Richtypo adds non-breaking spaces in right places, adds CSS classes for abbreviations, ampersands and hanging punctuation for special styling.

Features

• Rules for English and Russian languages
• Non-breaking spaces after prepositions and conjunctions, before em-dash, etc.
• <nobr> for words with hyphens
• CSS classes for abbreviations, ampersands and hanging punctuation
• Takes care of your HTML tags
• Simple typographer (quotes, em-dash, etc.) for user generated content (e.g. comments)

Example

var richtypo = require('richtypo');
var beautiful = richtypo.rich('Welcome to the world of beautiful web typography — only with Richtypo.');
var awesome = richtypo.title('Beautiful & Awesome Web Typography with “Richtypo”');

Will produce something like that:

Welcome to the world of beautiful web typography — only with Richtypo.
Beautiful <span class="amp">&amp;</span> Awesome Web Typography with <span class="slaquo"> </span> <span class="hlaquo">“</span>Richtypo”'

Installation

$ npm install [-g] richtypo

JavaScript API

Text processing: common use cases

richtypo.rich(text, lang)  // Enhancing typography: non-breaking spaces, abbreviations
richtypo.title(text, lang)  // Typography for big text: the same as rich + ampersands and hanging punctuation
richtypo.lite(text, lang)  // Simple typographer (quotes, em-dash, etc.) for user generated content (e.g. comments)
richtypo.full(text, lang)  // lite() + rich()

• text is an HTML string;
• lang (optional) is a text language ('en' or 'ru').

Text processing: custom set of rules

richtypo.richtypo(text, rulesets, lang)

• text is a HTML string;
• rulesets is array of rulesets (available rulesets: 'save_tags', 'cleanup_before', 'spaces_lite', 'spaces_lite', 'spaces', 'abbrs', 'amps', 'hanging', 'cleanup_after', 'restore_tags');
• lang (optional) is a text language ('en' or 'ru').

Change language globally

richtypo.lang(lang)

• lang is a language ('en' or 'ru').

Convert to text

If you don’t want HTML tags in the result string just wrap it in textify method:

richtypo.textify(richtypo.full(text, lang))

Command line

Usage: richtypo [--rules full] [--lang en] [--text] filename

Options

--rules RULESET (default: full)

Define ruleset:

• lite - Simple typographer (quotes, em-dash, etc.) for user generated content (e.g. comments);

• rich - Enhancing typography: non-breaking spaces, abbreviations;

• title - Typography for big text: the same as --rich + ampersands and hanging punctuation. [default: "full"]

• full - --light + --rich;

--lang LANG (default en)

Text language: en or ru.

--text

Convert result to text.

Release History

2013-04-25 v0.1.6

• Fix hanging punctuation.

2013-01-24 v0.1.5

• New API methods: full() and textify(). Fix rules loading when lang() method not invoked. CLI.

---

License

The MIT License, see the included License.md file.