dep-docs (in dev... now)

a simple tools to collect node modules's docs(readme) in your project.

API sample

var depDocs = requrie('dep-docs');

var docs = depDocs('./');

result's format:

[
    [readmePath1, readmePath2, ...],
    [module1, module2, ...]
]

first array is the readme path list, the second array is the module name list of those module didn't has a readme file.

CLI

$ docs ./

This command will generate html files from modules' readmea in node_modules/.docs and a _toc.html file.

If you are using Mac OS, the _toc.html will be opened with your default browser.

License

MIT © Leigh Zhu