# nodedocs

> Generate documentation from your cwd served up on localhost:0.0.0.0

Latest version **1.0.3** (published 2014-07-05) · ISC license · 0 weekly downloads

## Install

```sh
npm install nodedocs
pnpm add nodedocs
yarn add nodedocs
bun add nodedocs
```

Provides the command `nodedocs`.

## Health

**Score 5/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: insecure dependencies; abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.3 |
| Published | 2014-07-05 |
| First published | 2014-07-05 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | william.jblankenship@gmail.com |
| Maintainers | wblankenship |

## Links

- npm: https://www.npmjs.com/package/nodedocs
- npm.io page: https://npm.io/package/nodedocs

## Dependencies (3)

- [gfm2html](https://npm.io/package/gfm2html.md) git://github.com/wblankenship/gfm2html.git#master
- [readfiles](https://npm.io/package/readfiles.md) ^1.0.0
- [varstring](https://npm.io/package/varstring.md) ^0.2.0

## Recent versions

- 1.0.3 (latest) — 2014-07-05
- 1.0.2 — 2014-07-05
- 1.0.1 — 2014-07-05

## README

nodedocs
===

`nodedocs` is *THE* documentation tool for node.js. Starting from your current working directory, `nodedocs` will scan your _node\_modules_ directory for project _README.md_ files. It will build a nice little tree of your dependency list, with all of the READMEs served up on localhost!

# Usage

`nodedocs`

Output

```text
Building docs...
Done!
Staring server on 0.0.0.0:8080
```

You can now open your webbrowser and head on over to `127.0.0.1:8080` and you will see all the documentation for packages installed in your cwd!

![Imgur](http://i.imgur.com/jXHgEeg.png)

# Why does this exist?

Many languages have clunky auto-documenting tools that serve up local documentation. There is JavaDoc, godoc, etc. These rely on you to document function calls inline. This is dumb. Why do I, as a consumer of your tool, care about its implementation? Documenting function calls accomplishes nothing, and fails to give you the larger picture of what the module is designed to do.

## Node got it right

Incubated in the github ecosystem, nearly every project has a proper _README.md_. To make this scenario even more awesome, npm hosts up this fantastic readme in the package manager. Nodes culture of decoupling documentation from code is fantastic.

## Cool, so READMEs, but why `nodedocs`?

I'm glad you asked. So the project you maintain uses an old version of hapi. You go out to npmjs.org or github.com to view it's documentation. Not surprisingly, this project has a fantastic _README.md_ file (it is node). You use this documentation, and your code throws up errors everywhere. Why? Hapi's api has changed, thus the doucmentation you are looking at online is different then the api for the module you have installed.

*But wait!*

It gets worse. You are working on an awesome project in an airport terminal. You `npm install --save gfm2html` and immediately the come over the intercom saying it is time to board the plane. You get on the plane and immediately realize you didn't open github to view gfm2html's documentation... Wait! nodedocs to the rescue! Instead of paying $400 for 15 minutes of internet through American Airlines, simply type `nodedocs` for the low low price of free!

# How to make a dirty martini

```text
- 1 shotglass of Dry Vermouth
- 2 shotglasses of Gin
- 1 olive
- 1 tablespoon of olive juice
- 1 shaker
- As much ice as can fit in the shaker
Mix olive juice, gin, and vermouth in the shaker. Strain into martini glass.
Kick back and enjoy your locally served node documentation.
```

---
_Source: https://npm.io/package/nodedocs · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._