gulp-biscotto

v0.0.8
A Gulp-friendly module to generate [Biscotto](https://github.com/atom/biscotto) documentation from CoffeeScripts and return the output files.
biscotto documentation coffeescript tomdoc gulpfriendly

gulp-biscotto NPM version Build Status Dependency Status

A Gulp-friendly module to generate Biscotto documentation from CoffeeScripts and return the output files.

Installation

npm install gulp-biscotto

Usage

This isn't like a typical Gulp plugin. gulp-biscotto is to be used in place of gulp.src. It will "source" the output files Biscotto would've generated and then you can do whatever you'd like with them.

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

biscotto()
    .pipe(gulp.dest('./docs'));

There are no options. See Biscotto's .biscottoopts file (Note: when using a .biscottoopts file, it must be in the same directory as your gulpfile.js).

npm i gulp-biscotto

Metadata

  • MIT
  • Whatever
  • Adam Lynch
  • released 8/8/2014

Downloads

Maintainers