node package manager

documentator

[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 
    });