Running

There are two ways to run this application however it's likely you'll need to change configuration of the application to meet your needs (which is explained in the next section):

app.js

Use app.js when you want to run the API viewer using node and view over HTTP using Node.js express/jade. The application by default can be viewed in a browser at http://localhost:3000

You don't need to generate any static docs, only details.json and tree.json are needed which are exported by Dojo's js-doc-parse application (however as explained, you will still need to include static HTML files for legacy doc versions if you want to also view 'legacy' docs)

Running the node.js app server API viewer

node app.js

spider.js

Use spider.js when you want to generate static documentation HTML files (so you can view using any HTTP server). The files will be generated in the public/api/{version} directory where the specified details.json and tree.json are located

You copy the output HTML docs to whatever HTTP server you use.

Generating HTML docs for static viewing

node spider.js