Generate an index from a directory
npm install indexifier


!npm
!node


This module generates a tree view of a given directory.
``
Usage: indexifier [options]
Options:
-h, --help output usage information
-V, --version output the version number
-e, --extensions The extensions to take into account (defaults to .htm,.html)
-I, --include
-E, --exclude
-H, --html Enable to generate HTML output
-L, --no-link-folders Do not link folders when in HTML output mode
-F, --no-empty-directories Do not include empty directories
-D, --max-depth Limit results to a maximum sub-directory depth
`
#### Install
`console`
npm install -g indexifier
#### Examples
`console`
indexifier ./ --extensions .html,.htm
would generate something like this:
``
A
├─┬ B
│ └── c.html
├── d.html
└── e.html
There is also an HTML flag that would generate the above output as linked HTML:
`console`
indexifier --extensions .html --html .
`html`
A
├─┬ B
│ └── c.html
├── a.html
└── b.html
> The links are always relative to the given directory.
``
indexifier(String directory [, opts={
fileTypes: Array.
include=undefined: Regexp,
exclude=undefined: Regexp,
isHtml=false: Boolean,
linkFolders=true: Boolean,
emptyFolders=true: Boolean,
maxDepth=Infinity: Number,
}]);
#### Install
`console`
npm install indexifier --save
#### Examples
Tree of files:
`js
const indexifier = require('indexifier');
const treeOfFiles = indexifier(__dirname);
`
Tree of HTML files:
`js
const indexifier = require('indexifier');
const treeOfHtmlFiles = indexifier(__dirname, { fileTypes: ['.html'] });
`
or for HTML output:
`js
const indexifier = require('indexifier');
const treeOfJpegFiles = indexifier(__dirname, {
fileTypes: ['.jpg', '.jpeg'],
isHtml: true
});
``