Node API docs in Markdown, HTML, or JSON
MIT License
Node API docs in Markdown, HTML, or JSON, as a readable stream.
var apidocs = require('node-api-docs');
apidocs.markdown('net')
.pipe(process.stdout);
nodeApiDocs.markdown(module)
Returns readable stream of Markdown.
nodeApiDocs.html(module)
Returns readable stream of HTML.
nodeApiDocs.json(module)
Returns readable stream of JSON.
error
nodeApiDocs(module).on('error', function(err))
Emitted if connection failed, or server responds with code other than 200.
nodeapi [--markdown | --html | --json] <module>
Writes docs to stdout, or pipes to pager if stdout is TTY.
nodeapi --list
Prints list of doc pages.
npm install node-api-docs
MIT