Skip to content

raiseandfall/broccoli-fileindex

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

17 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Broccoli-fileindex

Build Status Downloads

Outputs a HTML file that list links to other HTML pages

There is also a version for Gulp

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