Skip to content

Commit

Permalink
Add Docker image
Browse files Browse the repository at this point in the history
  • Loading branch information
thiagocaiubi committed Mar 15, 2017
1 parent 2df7cb4 commit f628bd1
Show file tree
Hide file tree
Showing 3 changed files with 33 additions and 2 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
doc/
docker-example/
node_modules/
tmp/
npm-debug.log
Expand Down
8 changes: 8 additions & 0 deletions Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
FROM node:6-alpine

RUN mkdir -p /apidoc
WORKDIR /apidoc

RUN npm install -g apidoc

ENTRYPOINT ["apidoc"]
26 changes: 24 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,28 @@ Documentation at [apidocjs.com](http://apidocjs.com) or as [Docset](https://gith

## Installation

`npm install apidoc -g`
```console
$ 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

Expand All @@ -40,7 +60,9 @@ Documentation at [apidocjs.com](http://apidocjs.com) or as [Docset](https://gith
*/
```

`apidoc -i example/ -o doc/`
```console
$ apidoc -i example/ -o doc/
```

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

Expand Down

0 comments on commit f628bd1

Please sign in to comment.