https://github.com/andrepolischuk/gulp-textr

Gulp plugin for Textr
https://github.com/andrepolischuk/gulp-textr

gulp gulp-plugin textr textr-plugins typography

Last synced: about 1 month ago
JSON representation

Gulp plugin for Textr

• Host: GitHub
• URL: https://github.com/andrepolischuk/gulp-textr
• Owner: andrepolischuk
• License: mit
• Created: 2015-10-23T11:03:00.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2017-04-20T08:57:00.000Z (almost 8 years ago)
• Last Synced: 2024-12-09T17:59:17.746Z (2 months ago)
• Topics: gulp, gulp-plugin, textr, textr-plugins, typography
• Language: JavaScript
• Size: 13.7 KB
• Stars: 4
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# gulp-textr [![Build Status][travis-image]][travis-url]

> Transform text with [Textr][textr]

## Install

```sh

npm install --save-dev gulp-textr

```

## Usage

```js

import gulp from 'gulp';

import textr from 'gulp-textr';

import quotes from 'typographic-quotes';

import ellipses from 'typographic-ellipses';

import spaces from 'typographic-single-spaces';

gulp.task('default', () => {

  return gulp.src('src/text.md') // Hello  "world"...

    .pipe(textr(

      [ spaces, quotes, ellipses ],

      { locale: 'en-us' }

    ))

    .pipe(gulp.dest('dist')); // Hello “world”…

});

```

## API

### textr(plugins[, defaults])

Create new transform stream.

#### plugins

Type: `array`

Array of [plugins][textr-plugins] and transform functions.

#### defaults

Type: `object`

Default options (see `textr` [defaults][textr-defaults]).

## License

MIT

[travis-url]: https://travis-ci.org/andrepolischuk/gulp-textr

[travis-image]: https://travis-ci.org/andrepolischuk/gulp-textr.svg?branch=master

[textr]: https://github.com/A/textr

[textr-defaults]: https://github.com/A/textr#textrdefaults

[textr-plugins]: https://www.npmjs.com/browse/keyword/textr