Docgen

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

npm install -g doc-gen

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

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

docgen -h
docgen help <command>

Name		Name	Last commit message	Last commit date
Latest commit History 26 Commits
dist/assets		dist/assets
docs		docs
lib		lib
src		src
.editorconfig		.editorconfig
.gitignore		.gitignore
.mversionrc		.mversionrc
.npmignore		.npmignore
.yarnrc		.yarnrc
CHANGELOG.md		CHANGELOG.md
Gruntfile.js		Gruntfile.js
LICENSE.md		LICENSE.md
README.md		README.md
bootstrap.sh		bootstrap.sh
bower.json		bower.json
docgen.json		docgen.json
npm-shrinkwrap.json		npm-shrinkwrap.json
package.json		package.json
run.js		run.js
tsconfig.json		tsconfig.json
tsd.json		tsd.json
tsd.lib.json		tsd.lib.json
tsd.ts.json		tsd.ts.json
yarn.lock		yarn.lock

RobinRadic/docgen