doc-gen

0.1.0 • Public • Published

Docgen

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

Documentation & Demonstration

  1. Installation
npm install -g doc-gen
  1. 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
  1. 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
  1. Command line help
docgen -h
docgen help <command>

Copyright/License

Copyright 2015 Robin Radic - MIT Licensed

Readme

Keywords

Package Sidebar

Install

npm i doc-gen

Weekly Downloads

2

Version

0.1.0

License

MIT

Unpacked Size

160 MB

Total Files

10219

Last publish

Collaborators

  • radic