https://github.com/floatdrop/gulp-bh

Gulp plugin for bh files rendering
https://github.com/floatdrop/gulp-bh

Last synced: about 1 month ago
JSON representation

Gulp plugin for bh files rendering

• Host: GitHub
• URL: https://github.com/floatdrop/gulp-bh
• Owner: floatdrop
• Created: 2014-08-20T13:39:39.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2014-08-25T16:51:37.000Z (over 10 years ago)
• Last Synced: 2024-11-27T18:49:58.194Z (about 2 months ago)
• Language: JavaScript
• Size: 156 KB
• Stars: 1
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

        
# gulp-bh

[![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Dependency Status][depstat-image]][depstat-url]

Plugin, that fetches `*.bh.js` files and renders bemjson. This is just a wrapper around [BH](https://github.com/enb-make/bh), all questions about BH should go there.

## Usage

```js

var gulp = require('gulp');

var bh = require('gulp-bh');

var bemjson = {

    block: 'page',

    tag: 'html',

    content: '
Hello world!'

};


gulp.src('*.bh.js')

    .pipe(bh(bemjson, 'index.html'))

    .pipe(gulp.dest('./dist'));

```

### API

#### bh(bemjson, filename, [options])

Creates writable stream, that consumes `*.bh.js` files. After `finish` event it will generate single file with compiled HTML from passed `bemjson`.

###### bemjson

Type: `Object`

###### filename

Type: `String`

###### options

Type: `Object`

See [setOptions](https://github.com/enb-make/bh/blob/master/lib/bh.js#L527-L538) in BH.

## License

MIT (c) 2014 Vsevolod Strukchinsky

[npm-url]: https://npmjs.org/package/gulp-bh

[npm-image]: http://img.shields.io/npm/v/gulp-bh.svg?style=flat

[travis-url]: http://travis-ci.org/floatdrop/gulp-bh

[travis-image]: http://img.shields.io/travis/floatdrop/gulp-bh.svg?branch=master&style=flat

[depstat-url]: https://david-dm.org/floatdrop/gulp-bh

[depstat-image]: http://img.shields.io/david/floatdrop/gulp-bh.svg?style=flat