gulp-frontnote

gulp-frontnote is FrontNote plugin for gulp

Required

This plugin requires

• gulp

Usage

First, install gulp-frontnote as a development dependency:

npm install --save-dev gulp-frontnote

Then, add it to your gulpfile.js:

var frontNote = require('gulp-frontnote');

gulp.src('src/**/*.css')
	.pipe(frontNote({
		// options
	}));

Options

Options supported by frontnote

Usage Examples

var frontNote = require('gulp-frontnote');

gulp.task('doc', function() {
	gulp.src('src/**/*.css')
		.pipe(frontNote({
			out: './doc',
			template: './my-template',
			overview: './overview.md',
			includePath: 'assets/**/*'
		}));
});