a documentation viewer for node
experimental and unreleased
a documentation viewer for node.js
from the existing
require() circuitry. This means that most packages in
npm, despite not having a
doc directory full of markdown files, have some
useful information available in nd. Nearly every package at least has a
README.md; nd will read this.
docs directory is present, or if there is a docs directory
specified in the
package.json of some module, documentation will be loaded
out of these directories.
For example, if we type
nd npm cli
We will get
npm/doc/cli/index.md. So, if additional arguments (besides the
module name) are provided, we try to find a file which is more specific:
we'll look for
module/arg1/arg2.md. This allows us to be flexible about the organization
of documentation within modules.