@adrenalin/gulp-file-indexer
v1.0.4
Published
Gulp plugin to take a series of files and turn them into an index page.
Readme
Gulp File Indexer
Gulp plugin to take a series of files and turn them into an index page.
Example usage:
gulp.task("build-index-page", function() {
return gulp
.src(["./flats/*.html"])
.pipe(fileIndex({ relativePath: "flats/" }))
.pipe(gulp.dest("./"));
});Options
| Name | Type | Default Value | Description |
| --------------- | --------- | ------------- | ---------------------------------------------------------- |
| relativePath | string | '' | Relative path to prepend to all links generated |
| onlyFilenames | boolean | false | Should the links only show the filenames, or the full path |
| showExtension | boolean | true | Should the file extension be shown on the links |
| pageTitle | string | Directory | Page title to use for the index page |
