Skip to content
This repository has been archived by the owner on Mar 30, 2021. It is now read-only.

balena-io/capitanodoc

Repository files navigation

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:

$ npm 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:

$ gulp test

Contribute

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

$ gulp lint

License

The project is licensed under the MIT license.

About

Documentation generator for Capitano projects

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published