resin-io/capitanodoc

Name: capitanodoc

Owner: Resin.io

Description: Documentation generator for Capitano projects

Created: 2015-08-19 11:42:57.0

Updated: 2016-11-14 00:14:12.0

Pushed: 2015-08-19 12:42:40.0

Homepage: null

Size: 120

Language: JavaScript

GitHub Committers

UserMost Recent Commit# Commits

Other Committers

UserEmailMost Recent Commit# Commits

README

capitanodoc

Documentation generator for Capitano projects

Role

The intention of this module is to generate documentation, by extracting information from specific fields found in a typical Capitano command.

Installation

Install capitanodoc by running:

m install --save capitanodoc
Support

If you're having any problem, please raise an issue on GitHub and the Resin.io team will be happy to help.

Tests

Run the test suite by doing:

lp test
Contribute

Before submitting a PR, please make sure that you include tests, and that coffeelint runs without any warning:

lp lint
License

The project is licensed under the MIT license.


This work is supported by the National Institutes of Health's National Center for Advancing Translational Sciences, Grant Number U24TR002306. This work is solely the responsibility of the creators and does not necessarily represent the official views of the National Institutes of Health.