Skip to content

Latest commit

 

History

History
31 lines (19 loc) · 840 Bytes

File metadata and controls

31 lines (19 loc) · 840 Bytes

generator-optidoc

A Yeoman generator for OptiRTC user interface component documentation.

Getting Started

Install Yeoman (if you do not already have it)

Not every new computer comes with a Yeoman pre-installed.

$ npm install -g yo

Install generator-optidoc

$ npm install -g generator-optidoc

Finally, change your command line directory to the to the root level of the OptiRTC javascript application you want to generate documentation for and initiate the generator:

$ yo optidoc

Answer the questions to initialize a Latex documentation file for a single component of your application (currently supports Angular.js Directives, Services, and Controllers as component types).

License

MIT License