Skip to content
/ ndex Public

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

License

Notifications You must be signed in to change notification settings

icai/ndex

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

12 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ndex

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

NPM Version NPM Downloads Linux Build MIT

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')

// reset to default template
ndex.reset()

Demo

https://blog.w3cub.com/html5canvas/html5canvas/

License

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

About

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

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published