# documentator

> Module generate documentation accross multiple node apps

Latest version **0.0.4** (published 2016-03-06) · MIT license · 0 weekly downloads

## Install

```sh
npm install documentator
pnpm add documentator
yarn add documentator
bun add documentator
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.4 |
| Published | 2016-03-06 |
| First published | 2016-03-06 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=4.0.0 |
| Dependencies | 12 |
| Known vulnerabilities | 0 (+5 in 2 direct dependencies) |
| Install scripts | no |
| Author | Javi Romero |
| Maintainers | elmurci |

## Links

- npm: https://www.npmjs.com/package/documentator
- Repository: https://github.com/elmurci/documentator
- Homepage: https://github.com/elmurci/documentator#readme
- Issues: https://github.com/elmurci/documentator/issues
- npm.io page: https://npm.io/package/documentator

## Dependencies (12)

- [chai](https://npm.io/package/chai.md) ^2.1.2
- [grunt](https://npm.io/package/grunt.md) ^0.4.5
- [mocha](https://npm.io/package/mocha.md) ^2.2.1
- [moment](https://npm.io/package/moment.md) ^2.10.3
- [bluebird](https://npm.io/package/bluebird.md) ^3.0.6
- [grunt-cli](https://npm.io/package/grunt-cli.md) ^0.1.13
- [assert-plus](https://npm.io/package/assert-plus.md) ^0.1.5
- [body-parser](https://npm.io/package/body-parser.md) ^1.12.2
- [moment-timezone](https://npm.io/package/moment-timezone.md) ^0.4.1
- [chai-as-promised](https://npm.io/package/chai-as-promised.md) ^4.3.0
- [load-grunt-tasks](https://npm.io/package/load-grunt-tasks.md) ^3.3.0
- [child-process-promise](https://npm.io/package/child-process-promise.md) ^1.1.0

## Recent versions

- 0.0.4 (latest) — 2016-03-06
- 0.0.3 — 2016-03-06
- 0.0.2 — 2016-03-06
- 0.0.1 — 2016-03-06

## README

[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

```js
"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
    });

```

---
_Source: https://npm.io/package/documentator · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._