ndex

A small tool to index your directory files and generate index.html

Setup

 
npm install ndex -g
 

Usage

 
ndex -p ../0636920013327/html5canvas -e html -i *index.html
 
# or 
 
ndex ../0636920013327/html5canvas -e html -i *index.html
 

const ndex = requre('ndex')
 
ndex('../0636920013327/html5canvas', 'html', '*index.html');
// (path: any, ext?: string, ignore?: boolean)
 

module ndex

 
const ndex: {
    (path: any, ext?: string, ignore?: boolean): void;
    config(template: any): void;
    glob: typeof G; // glob function
    treeFromPaths: (files: string[], baseDir: string, renderLabelFn: (arg0: Window, arg1: string, arg2: any, arg3: string, arg4: any, arg5: boolean) => string, options?: any) => any;
    renderData(files: any, baseDir: any, renderLabelFn: any, options?: {
        ...;
    }): any;
}
 

Custom Template

 
ndex.config('the js file which return a function')
 

License

Copyright (c) 2018 Terry Cai. Licensed under the MIT license.