node-api-docs

 [![Dependency Status][david-badge]][david]

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

[david]: https://david-dm.org/eush77/node-api-docs
[david-badge]: https://david-dm.org/eush77/node-api-docs.png

Example

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

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

API

$3

Returns readable stream of Markdown.

$3

Returns readable stream of HTML.

$3

Returns readable stream of JSON.

$3

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

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

CLI

$3

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

$3

Prints list of doc pages.

Install

`
npm install node-api-docs
``

License

MIT