Skip to content

Commit

Permalink
Remove old docker image
Browse files Browse the repository at this point in the history
Add newer docker image to project list.
  • Loading branch information
rottmann authored Nov 27, 2018
1 parent ed44d3d commit 8eda890
Showing 1 changed file with 6 additions and 19 deletions.
25 changes: 6 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,25 +32,6 @@ If you want ot work on this, please send me a PM.
$ npm install apidoc -g
```

### Alternative docker install

```console
$ docker pull apidoc/apidoc
```

Then you will need to mount your file storage `-v '<apidoc.json dir>:/apidoc'` to docker container.

Example:

```console
$ docker run --rm -v '$(PWD):/apidoc' -it apidoc/apidoc \
--input ./example \
--output ./docker-example \
-v
```

Creates from input files in `example/` a documentation in path `docker-example/`.

## Changelog

[CHANGELOG.md](https://github.com/apidoc/apidoc/blob/master/CHANGELOG.md)
Expand Down Expand Up @@ -175,6 +156,12 @@ apiDoc will auto include installed plugins.
* [gulp-apidoc-swagger](https://github.com/fsbahman/gulp-apidoc-swagger)
* [Docmaster](https://github.com/bonzzy/docmaster)


## Docker image

* https://hub.docker.com/r/jujhars13/docker-node-apidocjs/


## FAQ

* [Filter for public / private API](https://github.com/apidoc/grunt-apidoc/issues/27#issuecomment-147664797)
Expand Down

0 comments on commit 8eda890

Please sign in to comment.