Типограф на JavaScript
Типограф в действии с мобильной версией
Черты:
- гибкость и расширяемость;
- кроссбраузерность;
- мультиязычность;
- utf-8;
- поддержка Node.js;
- TDD.
Форматы:
Использование
В браузере
bower install typograf
<script src="dist/typograf.min.js"></script>
<script>
var tp = new Typograf({lang: 'ru'});
alert(tp.execute(' Мир - мой мир! '));
</script>
Node.js
npm install typograf
var Typograf = require('typograf'),
tp = new Typograf({lang: 'ru'});
console.log(tp.execute(' Мир - мой мир!! '));
Плагины
Командная строка
npm install typograf -g
typograf
— вывод справки
typograf -l ru my_file.txt
— типографировать текст по русским правилам
typograf -l en my_file.txt
— типографировать файл по английским правилам
typograf -l ru -d ru/punctuation/quot -e ru/optaling/* my_file.txt > new_my_file
— типографировать файл с отключенным правилом ru/punctuation/quot
и включенными правилами ru/optaling/*
API
Висячая пунктуация
По умолчанию висячая пунктуация отключена.
Для включения необходимо подключить правила:
var Typograf = require('typograf'),
tp = new Typograf({lang: 'ru'});
tp.enable('ru/optalign/*');
console.log(tp.execute('"Мир"'));
А также в HTML-код страницы добавить:
<link rel="stylesheet" href="dist/typograf.css" type="text/css" />
Включить/отключить правило
var tp = new Typograf({lang: 'ru'});
tp.enable('ru/money/ruble');
tp.disable('ru/money/ruble');
Изменить настройку у правила
var tp = new Typograf({lang: 'ru'});
tp.setting('common/nbsp/beforeShortLast', 'lengthLastWord', 5);
Добавить правило
Typograf.rule({
title: 'Пример правила',
name: 'common/other/parampampam',
sortIndex: 2000,
func: function(text) {
return text.replace(/parampampam/g, 'tryam');
}
});
Режим работы
var tp = new Typograf({lang: 'ru'});
tp.execute('...');
var tpName = new Typograf({lang: 'ru', mode: 'name'});
tpName.execute('...');
var tpDigit = new Typograf({lang: 'ru', mode: 'digit'});
tpDigit.execute('...');
Разработка
git clone https://github.com/typograf/typograf.git ./typograf
Пересборка и запуск тестов:
gulp && npm test
MIT License
Ссылки