doc-gen v0.1.0

Docgen

Static documentation generator for typescript, sass/scss & javascript packages.

Documentation & Demonstration

1. Installation

npm install -g doc-gen

2. Initialisation Inside the project directory for the project you want to generate documentation run the init command. This will create a docgen.json configuration file.

docgen init

3. Generating the static site Once you've edited docgen.json you can generate the site and start a local server to preview it.

docgen generate
docgen serve --watch

4. Command line help

docgen -h
docgen help <command>

Copyright/License

Copyright 2015 Robin Radic - MIT Licensed