Skip to content

Commit

Permalink
improve docs
Browse files Browse the repository at this point in the history
  • Loading branch information
aripalo committed Feb 10, 2018
1 parent b1073e0 commit 96f7037
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# gatsby-docker
Develop & Build [GatsbyJS](https://www.gatsbyjs.org/) static sites within a Docker container.

- 🚮 **Clutter-free host machine**: No need to install Node/Gatsby/Webpack/etc on your host machine! Only Docker required (tested on `v17.12.0`).
- 🏗 **Easy setup**: Automatic GatsbyJS site initializion with [`gatsby-starter-default`](http://gatsbyjs.github.io/gatsby-starter-default/) (unless already initialized)
- 👍 **Simple CLI API**: [`develop`/`stage`/`build`](#usage)
- 🍃 **Lightweight**'ish Docker image (size only ~`250 MB`)
- 🆕 **Recent NodeJS**: Container based on [NodeJS `v9.5` running in Alpine Linux](https://github.com/nodejs/docker-node/blob/db3b27c8388136b5e529861d7c3fa12fd8328301/9/alpine/Dockerfile)
- 📃 [MIT](https://github.com/aripalo/gatsby-docker/blob/master/LICENSE)-licensed
- 🚮 **Clutter-free host machine**: No need to install Node/Gatsby/Webpack/etc on your host machine! Only Docker required (tested on `v17.12.0`).
- 🏗 **Easy setup**: Automatic GatsbyJS site initializion with [`gatsby-starter-default`](http://gatsbyjs.github.io/gatsby-starter-default/) (unless already initialized)
- 👍 **Simple CLI API**: [`develop`/`stage`/`build`](#usage)
- 🍃 **Lightweight**'ish Docker image (size only ~`250 MB`)
- 🆕 **Recent NodeJS**: Container based on [NodeJS `v9.5` running in Alpine Linux](https://github.com/nodejs/docker-node/blob/db3b27c8388136b5e529861d7c3fa12fd8328301/9/alpine/Dockerfile)
- 📃 [MIT](https://github.com/aripalo/gatsby-docker/blob/master/LICENSE)-licensed



Expand All @@ -25,24 +25,24 @@ site/.cache

### Develop
```sh
docker run -it --rm -v $(pwd)/site:/site -p 8000:8000 gatsby-docker:latest develop
docker run -it --rm -v $(pwd)/site:/site -p 8000:8000 aripalo/gatsby-docker develop
```

### Stage

In other words, build and serve:
```sh
docker run -it --rm -v $(pwd)/site:/site -p 8000:8000 gatsby-docker:latest stage
docker run -it --rm -v $(pwd)/site:/site -p 8000:8000 aripalo/gatsby-docker stage
```

### Build

Builds production ready site into `site/public`:
```sh
docker run -it --rm -v $(pwd)/site:/site -p 8000:8000 gatsby-docker:latest build
docker run -it --rm -v $(pwd)/site:/site -p 8000:8000 aripalo/gatsby-docker build
```

### Run arbitary command inside the container
```sh
docker run -it --rm -v $(pwd)/site:/site -p 8000:8000 gatsby-docker:latest <YOUR-COMMAND-HERE>
docker run -it --rm -v $(pwd)/site:/site -p 8000:8000 aripalo/gatsby-docker <YOUR-COMMAND-HERE>
```

0 comments on commit 96f7037

Please sign in to comment.