https://github.com/raiseandfall/gulp-fileindex
Gulp plugin to output a list of pages links in an HTML page
https://github.com/raiseandfall/gulp-fileindex
fileindex gulp gulp-plugin
Last synced: 28 days ago
JSON representation
Gulp plugin to output a list of pages links in an HTML page
- Host: GitHub
- URL: https://github.com/raiseandfall/gulp-fileindex
- Owner: raiseandfall
- License: mit
- Created: 2016-03-29T20:45:09.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2017-07-10T12:45:44.000Z (almost 9 years ago)
- Last Synced: 2025-11-01T01:09:35.946Z (7 months ago)
- Topics: fileindex, gulp, gulp-plugin
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/gulp-fileindex
- Size: 7.81 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# gulp-fileindex
[](https://travis-ci.org/raiseandfall/gulp-fileindex) [](https://www.npmjs.com/package/gulp-fileindex)
> Outputs a list of pages links in an HTML page
> There is also a version for [Broccoli](https://github.com/raiseandfall/broccoli-fileindex)
## [CHANGELOG](./CHANGELOG.md)
## INSTALL
```shell
$ npm install gulp-fileindex
```
## USAGE
```javascript
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
```shell
$ npm run dev
# Only run the tests
$ npm run test
```
## LICENSE
MIT