Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
A local webapp to view the documentation and source of the npm packages you use
CoffeeScript JavaScript Ruby
branch: master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
assets
bin
public
views
.gitignore
Readme.md
app.coffee
nodeDocs.coffee
package.json
packageLoading.coffee
util.coffee

Readme.md

SuperDoc makes a nice local website to help you look at the npm packages you use. It currently can render their markdown docs. One day it will show api documentation and automatically docco-ify them.

Since we're not yet in npm, do this for now to get started:

git clone https://github.com/mullr/SuperDoc
cd SuperDoc
npm install
npm link

Then go to some directory in your project which uses npm and type superdoc.

SuperDoc was developed on OSX and may work on other platforms as well.

Something went wrong with that request. Please try again.