gulp-typograf

Prepare texts with Typograf using Gulp.

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
gulp-typograf
2714.1.0a year ago9 years agoMinified + gzip package size for gulp-typograf in KB

Readme

gulp-typograf ================================== NPM version NPM downloads
Prepare texts with Typograf using Gulp.

Install

npm install gulp-typograf --save-dev

Usage

const typograf = require('gulp-typograf');

gulp.task('typograf', function() {
    gulp.src('./src/*.html')
        .pipe(typograf({ locale: ['ru', 'en-US'] }))
        .pipe(gulp.dest('./public/'));
});

With additional options

.pipe(typograf({
    locale: ['ru', 'en-US'],
    // Type of HTML entities: 'digit' -  , 'name' -  , 'default' - UTF-8
    htmlEntity: { type: 'digit' },
    disableRule: ['ru/optalign/*'],
    enableRule: ['ru/money/ruble'],
    safeTags: [
        ['<\\?php', '\\?>'],
        ['<no-typography>', '</no-typography>']
    ],
    // Own rules
    rules: [
        {
            name: 'common/other/typographicalEmoticon',
            handler: function(text, settings) {
                return text.replace(/:-\)/, ':—)');
        },
        {
            name: 'common/other/trimLeft'
            handler: function(text, settings) {
                return text.trimLeft();
            }
        }
    ]
}))

Links