generator-jhipster-compodoc

[![NPM version][npm-image]][npm-url]
[![Dependency Status][daviddm-image]][daviddm-url]
> JHipster module, additional compodoc support in your JHipster application

Introduction

This is a JHipster module, that is meant to be used in a JHipster application.

Prerequisites

This module requires Jhipster version greater than 3.0.0 in order to work.

As this is a JHipster module, we expect you have JHipster and its related tools already installed:

- Installing JHipster

Installation

To install this module :

``bash
npm install -g generator-jhipster-compodoc
`

Usage

Run the module on your JHipster generated application :

`bash
yo jhipster-compodoc
`

Due to a limitation of yeoman about file override, you will have to accept the overwrite question.

`bash
conflict package.json
? Overwrite package.json? (Ynaxdh)
`

Enjoy compodoc in your Angular application

`bash
npm run doc
``

License

MIT © [Vincent Ogloblinsky]

[npm-image]: https://img.shields.io/npm/v/generator-jhipster-compodoc.svg
[npm-url]: https://npmjs.org/package/generator-jhipster-compodoc
[travis-image]: https://travis-ci.org/compodoc/generator-jhipster-compodoc.svg?branch=master
[travis-url]: https://travis-ci.org/compodoc/generator-jhipster-compodoc
[daviddm-image]: https://david-dm.org/compodoc/generator-jhipster-compodoc.svg?theme=shields.io
[daviddm-url]: https://david-dm.org/compodoc/generator-jhipster-module