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
- Host: GitHub
- URL: https://github.com/cgewecke/gulp-documentation-bleno
- Owner: cgewecke
- License: bsd-2-clause
- Created: 2016-11-29T20:30:24.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2016-12-01T02:16:07.000Z (over 8 years ago)
- Last Synced: 2025-02-09T02:26:41.382Z (4 months ago)
- Language: JavaScript
- Homepage:
- Size: 5.86 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
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)**