iamdenny/gulp-groc

A simple gulp plug-in to generate a project's documentation using Groc

gulp-groc

groc plugin for gulp

Usage

First, install gulp-groc as a development dependency:

npm install --save-dev gulp-groc

Then, add it to your gulpfile.js:

var gulp = require('gulp'),
    groc = require("gulp-groc"),
    clean = require('gulp-clean');

// clean doc
gulp.task('cleanDoc', function () {
    return gulp
        .src([ 'jsdoc' ], {
            read: false
        })
        .pipe(clean());
});

// gulp-groc
gulp.task('doc', [ 'cleanDoc' ], function () {
    return gulp
        .src("./src/scripts/**/*.js")
        .pipe(groc({
            out: 'jsdoc'
        }));
});

API

groc(options)

options

Type: Object Default: {}

There are options supported by groc, if you are interested.

License

MIT License

Copyright (c) 2014 NAVER Corp.