bf

broccoli-fileindex

Outputs a HTML page with a list of links to other pages

Showing:

Popularity

Downloads/wk

2

GitHub Stars

0

Maintenance

Last Commit

4yrs ago

Contributors

2

Package

Dependencies

3

License

MIT

Type Definitions

Tree-Shakeable

No?

Categories

Readme

Broccoli-fileindex

Build Status Downloads

Outputs a HTML file that list links to other HTML pages

There is also a version for Gulp

CHANGELOG

INSTALL

$ npm install broccoli-fileindex

USAGE

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

var tree = fileindex(html, {
  files: ['**/*.html'],
  dest: 'index.html'
});

OPTIONS

fileindex(tree, options)

options.files

Type: Array
Required

This option is the glob of the pages you want to generate the links.

options.dest

Type: String
Optional
Default index.html

Path to the HTML page to generate.

options.showOnlyFilenames

Type: Boolean
Optional
Default false

Whether ot not to show only the filenames in the HTML listing page

CONTRIBUTE

$ npm run test

LICENSE

MIT

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100
No reviews found
Be the first to rate

Alternatives

No alternatives found

Tutorials

No tutorials found
Add a tutorial