documentator
Module generate documentation accross multiple node apps
Last updated 4 years ago by elmurci .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install documentator 
SYNC missed versions from official npm registry.

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

Current Tags

  • 0.0.4                                ...           latest (4 years ago)

4 Versions

  • 0.0.4                                ...           4 years ago
  • 0.0.1                                ...           4 years ago
  • 0.0.3                                ...           4 years ago
  • 0.0.2                                ...           4 years ago
Maintainers (1)
Downloads
Today 0
This Week 0
This Month 1
Last Day 0
Last Week 1
Last Month 4
Dependencies (12)
Dev Dependencies (3)
Dependents (0)
None

Copyright 2014 - 2017 © taobao.org |