Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

typograf

Package Overview
Dependencies
Maintainers
1
Versions
101
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

typograf

The client and server typographer

  • 2.9.0
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
12K
increased by29.9%
Maintainers
1
Weekly downloads
 
Created
Source

Типограф на JavaScript

NPM version NPM downloads Build Status Build Status Coverage Status

Dependency Status devDependency Status

Типограф в действии с мобильной версией

Черты:

  • гибкость и расширяемость;
  • кроссбраузерность;
  • мультиязычность;
  • utf-8;
  • поддержка Node.js;
  • TDD.

Поддерживаемые правила

Форматы:

  • HTML
  • TXT
  • SVG
  • XML

Использование

В браузере

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');
    }
});

Режим работы

// Режим по умолчанию, HTML-сущности, как utf-8 символы
var tp = new Typograf({lang: 'ru'});
tp.execute('...'); // …

// HTML-сущности, как имена
var tpName = new Typograf({lang: 'ru', mode: 'name'});
tpName.execute('...'); // &hellip;

// HTML-сущности, как цифры
var tpDigit = new Typograf({lang: 'ru', mode: 'digit'});
tpDigit.execute('...'); // &#8230;

Разработка

git clone https://github.com/typograf/typograf.git ./typograf

Пересборка и запуск тестов: gulp && npm test

Лицензия

MIT License

Ссылки

Keywords

FAQs

Package last updated on 04 Mar 2015

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc