An open API service indexing awesome lists of open source software.

https://github.com/cgewecke/gulp-documentation-bleno

gulp-documentation for documentation-bleno
https://github.com/cgewecke/gulp-documentation-bleno

Last synced: 2 months ago
JSON representation

gulp-documentation for documentation-bleno

Awesome Lists containing this project

README

        

# gulp-documentation-bleno

Use [gulp](http://gulpjs.com/) with
[documentation-bleno](https://github.com/cgewecke/documentation-bleno)
to generate markdown docs for bleno characteristic handlers.

(Source: [gulp-documentation](https://github.com/documentationjs/gulp-documentation))

## Installation

```sh
$ npm install --save-dev https://github.com/cgewecke/gulp-documentation-bleno
```

## API

### documentation

Documentation stream intended for use within the gulp system.

**Parameters**

- `format` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** format 'md'
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** documentation options - the same as given to [documentation](https://github.com/documentationjs/documentation)
- `options.filename` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** custom filename for md or json output
- `formatterOptions` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** output options - same as given to documentation
- `formatterOptions.name` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** if format is HTML, specifies the name of the project

**Examples**

```javascript
var gulpDocumentation = require('gulp-documentation-bleno');
var gulp = require('gulp');

gulp.task('bleno-handlers', function () {
// Generating characteristic defs documentation w/ line #s
return gulp.src('./sample.js')
.pipe(gulpDocumentation('md', { shallow: 'true', github: 'true', filename: 'sample.md' }))
.pipe(gulp.dest('./'));
});

```

Returns **[stream.Transform](https://nodejs.org/api/stream.html#stream_class_stream_transform)**