Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
a fledgling `perldoc` for node.js
Python
tag: 1.0.2

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
bin
deps
doc/api
tools
.gitignore
CHANGES.md
DEVNOTES.txt
Makefile
README.md
package.json

README.md

A fledgling perldoc for node.js.

Installation

  1. Get node.

  2. npm install -g nodedoc

You should now have "nodedoc" on your PATH:

$ nodedoc --version
nodedoc 1.0.0

Status

This really is a quick hack. There are a number of limitations in the current Markdown -> HTML -> ANSI escape-colored text. Among them:

  • nested lists aren't handled properly
  • <ol> aren't handled properly

The current version of the node.js docs is a snapshot of the https://github.com/joyent/node master.

Examples

This will render and color the fs.markdown core docs and page through them (using your PAGER environment setting, if any):

$ nodedoc fs

List all nodedoc sections:

$ nodedoc -l
Something went wrong with that request. Please try again.