Generate an index from a directory
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
__tests__
bin
.gitignore
.travis.yml
LICENSE
README.md
dirTreeToArchyTree.js
exceptions.js
index.js
package.json
wrapHref.js
wrapHtml.js
yarn.lock

README.md

Generate an index for a given directory

Greenkeeper badge

Build status npm npm node Commitizen friendly semantic-release

This module generates a tree view of a given directory.

Usage

CLI API

Usage: indexifier [options] <dir>

Options:

  -h, --help                  output usage information
  -V, --version               output the version number
  -e, --extensions <list>     The extensions to take into account; defaults to .htm,.html
  -E, --exclude <regexp>      Exclude files and directories that are matched by this regular expression
  -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

Install

npm install -g indexifier

Examples

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:

indexifier --extensions .html --html .
<!-- ... -->
<a href="./">A</a><br/>
├─┬ <a href="./B">B</a><br/>
│ └── <a href="./B/c.html">c.html</a><br/>
├── <a href="./d.html">a.html</a><br/>
└── <a href="./e.html">b.html</a><br/>
<!-- ... -->

The links are always relative to the given directory.

Node API

indexifier(String directory [, opts={
                                     fileTypes: Array.<String>
                                     isHtml=false: Boolean,
                                     linkFolders=true: Boolean
                                     emptyFolders=true: Boolean
                                    }]);

Install

npm install indexifier --save

Examples

Tree of files:

const indexifier = require('indexifier');

const treeOfFiles = indexifier(__dirname);

Tree of HTML files:

const indexifier = require('indexifier');

const treeOfHtmlFiles = indexifier(__dirname, { fileTypes: ['.html'] });

or for HTML output:

const indexifier = require('indexifier');

const treeOfJpegFiles = indexifier(__dirname, {
    fileTypes: ['.jpg', '.jpeg'],
    isHtml: true
});