Sign inSign up

etiennetremel/apidoc

By etiennetremel

•Updated over 8 years ago

ApiDoc container with iNotify to build doc on file change

Image
0

1.7K

etiennetremel/apidoc repository overview

⁠Docker ApiDoc

ApiDoc⁠ container with inotify feature to rebuild documentation on file change.

Docker build status Image size

⁠Getting started

# Build
$ docker build -t apidoc .

# Create shared volume
$ docker volume create apidoc

# Clone the ApiDoc example documentation
$ git clone https://github.com/apidoc/apidoc.git
$ cd apidoc/example

# Run API Doc
$ docker run -d \
    --name=apidoc \
    -v $PWD:/src:ro \
    -v apidoc:/dest \
    apidoc --input=/src --output=/dest

# Run Nginx
$ docker run -d \
    --name=nginx \
    -v apidoc:/usr/share/nginx/html:ro \
    -p 8080:80 \
    nginx:alpine

Open http://localhost:8080⁠

⁠Known issues

If running on OSX, iNotify will not work as expected as the events doesn't get correcty propagated.

Tag summary

Content type

Image

Digest

Size

24.5 MB

Last updated

over 8 years ago

docker pull etiennetremel/apidoc