README

gulp-fileindex

Outputs a list of pages links in an HTML page

There is also a version for Broccoli

CHANGELOG

INSTALL

$ npm install gulp-fileindex

USAGE

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

gulp.task('fileindex', function() {
  return gulp.src('pages/*.html')
    .pipe(fileindex())
    .pipe(gulp.dest('./'));
});

OPTIONS

fileindex(outputFilename, options)

outputFilename

Type: String
Optional
Default index.html

Filename for the listing page where the links will be written.

options.onlyFilenames

Type: Boolean
Optional
Default false

Wether or not to show only the filenames in the HTML listing page.

options.showExtension

Type: Boolean
Optional
Default true

Wether or not to show the pages' file extension

CONTRIBUTE

$ npm run dev

# Only run the tests
$ npm run test

LICENSE

MIT

Usage no npm install needed!