rjelierse/dgeni-skeleton

Skeleton for dgeni documentation generator

JavaScript

dgeni-skeleton

Skeleton for generating documentation for your AngularJS project using dgeni

Installation

Check out this repository from Github:

$ git clone https://github.com/rjelierse/dgeni-skeleton

Install the project dependencies:
```
$ npm install
```

Usage

Configure the path to your source code in config/index.js.
Run Gulp:
```
$ gulp
```
This command builds the documentation and creates a deployment-ready tree in build.

You can also run a local development server to test your documentation suite:
```
$ gulp server
```