Sign Up for Free

RunKit +

Try any Node.js package right in your browser

This is a playground to test code. It runs a full Node.js environment and already has all of npm’s 400,000 packages pre-installed, including documentator with all npm packages installed. Try it out:

var documentator = require("documentator")

This service is provided by RunKit and is not affiliated with npm, Inc or the package authors.

documentator v0.0.4

Module generate documentation accross multiple node apps

[Still under development]

documentator

Simple module to generate documentation across multiple nodejs4+ applications.

Requirements

apidocjs pandoc BasicTex

Installation

$ npm install documentor --save

Setting up

Direct configuration

"use strict";

Documentator = require('../index'),
documentator = new Documentator(
    {
        apps: [
        {
            'name': 'UpdaterApi',
            'from': 'src/server/routes'
        }
    ],
        template: "path"
    }); 
    }

    var result = documentator.generate(
        '1.0.0',
        '/doc/api'
    )
    .then(function(res) {
        // do something
    })
    .catch(function(err){
        // do something
    });

Metadata

RunKit is a free, in-browser JavaScript dev environment for prototyping Node.js code, with every npm package installed. Sign up to share your code.
Sign Up for Free