https://github.com/robinradic/docgen
Static documentation generator.
https://github.com/robinradic/docgen
Last synced: 10 months ago
JSON representation
Static documentation generator.
- Host: GitHub
- URL: https://github.com/robinradic/docgen
- Owner: RobinRadic
- License: mit
- Created: 2015-09-05T02:53:45.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2018-03-21T13:25:56.000Z (over 8 years ago)
- Last Synced: 2025-08-09T04:44:57.591Z (11 months ago)
- Language: CSS
- Homepage: http://robin.radic.nl/docgen
- Size: 14.8 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
Docgen
==============
Static documentation generator for typescript, sass/scss & javascript packages.
[Documentation & Demonstration](http://robin.radic.nl/docgen)
1. Installation
```sh
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.
```sh
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.
```sh
docgen generate
docgen serve --watch
```
4. Command line help
```sh
docgen -h
docgen help
```
### Copyright/License
Copyright 2015 [Robin Radic](https://github.com/RobinRadic) - [MIT Licensed](http://radic.mit-license.org)