node-api-docs

Node API docs in Markdown, HTML, or JSON, as a readable stream.

Example

var apidocs = require('node-api-docs');

apidocs.markdown('net')
  .pipe(process.stdout);

API

nodeApiDocs.markdown(module)

Returns readable stream of Markdown.

nodeApiDocs.html(module)

Returns readable stream of HTML.

nodeApiDocs.json(module)

Returns readable stream of JSON.

Event: error

nodeApiDocs(module).on('error', function(err))

Emitted if connection failed, or server responds with code other than 200.

CLI

nodeapi [--markdown | --html | --json] <module>

Writes docs to stdout, or pipes to pager if stdout is TTY.

nodeapi --list

Prints list of doc pages.

Install

npm install node-api-docs

License

MIT