https://github.com/sticksnleaves/docker-graphdoc
Docker image for graphdoc
https://github.com/sticksnleaves/docker-graphdoc
dockerfile graphdoc graphql
Last synced: 11 months ago
JSON representation
Docker image for graphdoc
- Host: GitHub
- URL: https://github.com/sticksnleaves/docker-graphdoc
- Owner: sticksnleaves
- License: mit
- Created: 2017-08-15T14:47:08.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-08-15T15:55:06.000Z (over 8 years ago)
- Last Synced: 2025-01-13T20:47:36.840Z (about 1 year ago)
- Topics: dockerfile, graphdoc, graphql
- Homepage:
- Size: 2.93 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Supported tags and respective `Dockerfile` links
* [`2.4.0`, `2.4`, `2`, `latest` (2.4/Dockerfile)](https://github.com/sticksnleaves/docker-graphdoc/blob/f10e1afa7273d67a2b7c2402ff580f65f39267df/2.4/Dockerfile)
# How to use this image
## Generate documentation from live endpoint
```
$ docker run sticksnleaves/graphdoc graphdoc -e http://localhost:8080/graphql -o ./doc/schema
```
## Generate documentation from IDL file
```
$ docker run sticksnleaves/graphdoc graphdoc -s ./schema.graphql -o ./doc/schema
```
## Generate documentation from for the "modularized schema" of graphql-tools
```
$ docker run sticksnleaves/graphdoc graphdoc -s ./schema.js -o ./doc/schema
```
## Generate documentation from json file
```
$ docker run sticksnleaves/graphdoc graphdoc -s ./schema.json -o ./doc/schema
```
For more information on using graphdoc please read the [official documentation](https://github.com/2fd/graphdoc).